Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
jean-emmanuel committed Aug 21, 2023
1 parent 6122b7c commit f2f1949
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion resources/docs/docs/widgets/properties-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
| <h6 id="button_off">off<sup><i class="fas fa-bolt" title="dynamic"></i></sup><a class="headerlink" href="#button_off" title="Permanent link">#</a></h6> | `*` | <code>0</code> | Set to `null` to send send no argument in the osc message. Must be different from `on`. Ignored if `mode` is `momentary` or `tap`. |
| <h6 id="button_mode">mode<a class="headerlink" href="#button_mode" title="Permanent link">#</a></h6> | `string` | <code>"toggle"</code> | Interaction mode:<br/>- `toggle` (classic on/off switch)<br/>- `push` (press & release)<br/>- `momentary` (no release, no value sent with the address)<br/>- `tap` (no release, sends `on` as value)<br/><br/>Choices: `toggle`, `push`, `momentary`, `tap` |
| <h6 id="button_doubleTap">doubleTap<a class="headerlink" href="#button_doubleTap" title="Permanent link">#</a></h6> | `boolean` | <code>false</code> | Set to `true` to make the button require a double tap to be pushed instead of a single tap |
| <h6 id="button_decoupled">decoupled<a class="headerlink" href="#button_decoupled" title="Permanent link">#</a></h6> | `boolean` | <code>false</code> | Set to `true` make the local feedback update only when it receives a value from an osc/midi message that matches the `on` or `off` property.<br/><br/>When `decoupled`, the button's value is ambiguous: when interacted with, it will send the value that's requested (`on` or `off` for `toggle` and `push` modes, `on` for `tap` mode, `null` for `momentary`), otherwise it will return the value received from the feedback message (`on` or `off` property).<br/>- `decoupled (toggle mode that only updates its state when it receives a value from an osc/midi message*)`<br/><br/>From a script property, feedback messages can be simulated with:<br/><br/>`set("widget_id", value, {external: true})` |
| <h6 id="button_decoupled">decoupled<a class="headerlink" href="#button_decoupled" title="Permanent link">#</a></h6> | `boolean` | <code>false</code> | Set to `true` make the local feedback update only when it receives a value from an osc/midi message that matches the `on` or `off` property.<br/><br/>When `decoupled`, the button's value is ambiguous: when interacted with, it will send the value that's requested (`on` or `off` for `toggle` and `push` modes, `on` for `tap` mode, `null` for `momentary`), otherwise it will return the value received from the feedback message (`on` or `off` property).<br/><br/>From a script property, feedback messages can be simulated with:<br/><br/>`set("widget_id", value, {external: true})` |

=== "scripting"

Expand Down
2 changes: 1 addition & 1 deletion resources/docs/docs/widgets/scripting.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,4 +380,4 @@ Opens the file file browser and pass selected file to a callback function (does
- `extension`: allowed extension (default: "*")
- `directory`: starting directory for browser (default: user's home)
- `allowDir`: allow choosing a directory instead of a file (default: false)
- `mode`: "save" or "open"
- `mode`: "save" or "open"

0 comments on commit f2f1949

Please sign in to comment.