feat(docs): Document modifiers widget

zmkfirmware · Dec 2, 2022 · bdd4f45 · bdd4f45
1 parent 6207bad
commit bdd4f45
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/docs/config/displays.md b/docs/docs/config/displays.md
@@ -21,6 +21,9 @@ Definition files:
 | `CONFIG_ZMK_WIDGET_BATTERY_STATUS` | bool | Enable a widget to show battery charge information   | y       |
 | `CONFIG_ZMK_WIDGET_OUTPUT_STATUS`  | bool | Enable a widget to show the current output (USB/BLE) | y       |
 | `CONFIG_ZMK_WIDGET_WPM_STATUS`     | bool | Enable a widget to show words per minute             | n       |
+| `CONFIG_ZMK_WIDGET_MODS_STATUS`    | bool | Enable a widget to show active modifiers             | n       |
+
+Note that WPM and modifiers widgets are both shown on the bottom right of the display and hence can conflict with each other.
 
 If `CONFIG_ZMK_DISPLAY` is enabled, exactly zero or one of the following options must be set to `y`. The first option is used if none are set.