docs: Improve documentation related to microphone toggle (#2165)

- Related: #2161
This commit is contained in:
Dermot Duffy
2025-08-29 20:19:26 -07:00
committed by GitHub
parent 109e74bd2a
commit 3da1459ba6
+13 -2
View File
@@ -17,8 +17,6 @@ menu:
## `buttons` ## `buttons`
All configuration is under:
```yaml ```yaml
menu: menu:
buttons: buttons:
@@ -60,6 +58,19 @@ menu:
| `permanent` | `false` | If `false` the menu item is hidden when the menu has the `hidden` style and the menu is closed, otherwise it is shown (and sorted to the front). | | `permanent` | `false` | If `false` the menu item is hidden when the menu has the `hidden` style and the menu is closed, otherwise it is shown (and sorted to the front). |
| `priority` | `50` | The menu item priority. Higher priority items are ordered closer to the start of the menu alignment (i.e. a button with priority `70` will order further to the left than a button with priority `60`). Priority applies separately to `matching` and `opposing` groups (see `alignment` above). Minimum `0`, maximum `100`. | | `priority` | `50` | The menu item priority. Higher priority items are ordered closer to the start of the menu alignment (i.e. a button with priority `70` will order further to the left than a button with priority `60`). Priority applies separately to `matching` and `opposing` groups (see `alignment` above). Minimum `0`, maximum `100`. |
### Additional options: `microphone`
```yaml
menu:
buttons:
microphone:
# [...]
```
| Option | Default | Description |
| ------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | `momentary` | When `momentary` the button must be continually held down to talk, when `toggle` pressing the button will enable the microphone and it must be pressed again to disable it. |
## `style` ## `style`
This card supports several menu styles. This card supports several menu styles.