Skip to content

Commit

Permalink
ui-control colon in group name (docs)
Browse files Browse the repository at this point in the history
  • Loading branch information
bartbutenaers committed Dec 21, 2024
1 parent 00e06ee commit 067210e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/nodes/widgets/ui-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ msg.payload = {
```

_Note:_ `pages` can be subbed with `tabs` as per Dashboard 1.0 and `groups` can also be subbed with `group` as per Dashboard 1.0.
_Note:_ when the `group` name contains a colon `:`, then that should be escaped using a backslash `\`.

### Enable/Disable

Expand Down Expand Up @@ -187,4 +188,4 @@ msg = {
tab: '<Page Index>',
name: '<Page Name>'
}
```
```
5 changes: 3 additions & 2 deletions nodes/widgets/locales/en-US/ui_control.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h4>Show/Hide Pages & Groups</h4>
}
}</pre>
<h4>Enable/Disable Pages & Groups</h4>
<p>Dashboard pages & groups can be disabled & re-enabled by sending a <code>msg.payload</code> object with the format
<p>Dashboard pages & groups can be disabled & re-enabled by sending a <code>msg.payload</code> object with the format</p>
<pre>msg.payload = {
pages: {
enable: ['&lt;Page Name&gt;', '&lt;Page Name&gt;'],
Expand All @@ -44,6 +44,7 @@ <h4>Enable/Disable Pages & Groups</h4>
disable: ['&lt;Group Name&gt;']
}
}</pre>
<p>When the group name contains a colon <code>:</code>, that needs to be escaped using a backslash <code>\</code>. </p>
<h4>External URL</h4>
<p>It is possible to trigger navigation to an external site, away from your Dashboard by passing in a URL string.</p>
<pre>msg.payload = {
Expand All @@ -64,4 +65,4 @@ <h3>Events List</h3>
<li><code>name</code> - the name of the tab. (only for 'change' event).
</ul>
<p>Optional - report only connect events - useful to use to trigger a resend of data to a new client without needing to filter out other events.</p>
</script>
</script>

0 comments on commit 067210e

Please sign in to comment.