diff options
| author | Ivan Molodetskikh <yalterz@gmail.com> | 2025-08-26 22:05:05 +0300 |
|---|---|---|
| committer | Ivan Molodetskikh <yalterz@gmail.com> | 2025-08-26 22:09:58 +0300 |
| commit | 39e5f637eff823d95153216ac55b11ca01fbc593 (patch) | |
| tree | 202f1c9174ba0ae2f3e829af9731e83e5a3d4c5b /docs | |
| parent | effae2bc2b38012c1a362fc16e40e8fbaed0dc31 (diff) | |
| download | niri-39e5f637eff823d95153216ac55b11ca01fbc593.tar.gz niri-39e5f637eff823d95153216ac55b11ca01fbc593.tar.bz2 niri-39e5f637eff823d95153216ac55b11ca01fbc593.zip | |
wiki: Add Accessibility page
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/mkdocs.yaml | 1 | ||||
| -rw-r--r-- | docs/wiki/Accessibility.md | 18 | ||||
| -rw-r--r-- | docs/wiki/_Sidebar.md | 1 |
3 files changed, 20 insertions, 0 deletions
diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index 5152e0b7..d3dc4d29 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -85,6 +85,7 @@ nav: - Xwayland: Xwayland.md - Gestures: Gestures.md - Packaging niri: Packaging-niri.md + - Accessibility: Accessibility.md - FAQ: FAQ.md - Configuration: - Introduction: Configuration:-Introduction.md diff --git a/docs/wiki/Accessibility.md b/docs/wiki/Accessibility.md new file mode 100644 index 00000000..225093f3 --- /dev/null +++ b/docs/wiki/Accessibility.md @@ -0,0 +1,18 @@ +## Screen readers + +Niri has basic support for screen readers (specifically, [Orca](https://orca.gnome.org)). +We implement the `org.freedesktop.a11y.KeyboardMonitor` D-Bus interface for Orca to listen and grab keyboard keys, and we expose the main niri UI elements via [AccessKit](https://accesskit.dev). + +Make sure [Xwayland](./Xwayland.md) works, then run `orca`. +The default config binds <kbd>Super</kbd><kbd>Alt</kbd><kbd>S</kbd> to toggle Orca, which is the standard key binding. + +If you're shipping niri and would like to make it work better for screen readers out of the box, consider the following changes to the default niri config: + +- Change the default terminal from Alacritty to one that supports screen readers. For example, [GNOME Console](https://gitlab.gnome.org/GNOME/console) or [GNOME Terminal](https://gitlab.gnome.org/GNOME/gnome-terminal) should work well. +- Change the default application launcher and screen locker to ones that support screen readers. Suggestions welcome! Likely, something GTK-based will work fine. +- Add some `spawn-at-startup` command that plays a sound which will indicate to users that niri has finished loading. +- Add `spawn-at-startup "orca"` to run Orca automatically at niri startup. + +## Desktop zoom + +There's no built-in zoom yet, but you can use third-party utilities like [wooz](https://github.com/negrel/wooz). diff --git a/docs/wiki/_Sidebar.md b/docs/wiki/_Sidebar.md index 4c25efec..5dcddf45 100644 --- a/docs/wiki/_Sidebar.md +++ b/docs/wiki/_Sidebar.md @@ -14,6 +14,7 @@ * [Xwayland](./Xwayland.md) * [Gestures](./Gestures.md) * [Packaging niri](./Packaging-niri.md) +* [Accessibility](./Accessibility.md) * [FAQ](./FAQ.md) ## Configuration |