Skip to content

Commit 0b5cdee

Browse files
C-Loftuspokey
andauthored
Add a page about visual impairments to the docs (#2258)
Fixes #935 I specifically addressed everything in that issue. If desired, I could reference my sight free repository or any of the discussions Pokey and I had with Parham. I wasn't entirely sure since on one hand what I wrote up doesn't discuss anything about blindness or visual impairments that affect the ability to see the hats regardless of size, but on the other hand that is relatively specific and would require referencing another package outside the repository which I don't want to cause issues. I continue to be interested generally about ways to make cursorless better for non-visual use but realistically this might be more of a stretch goal and not for this PR ## Checklist (First take in checklist not relevant since no code is changed) - [x] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [x] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [x] I have not broken the cheatsheet --------- Co-authored-by: Pokey Rule <[email protected]>
1 parent b01b553 commit 0b5cdee

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

docs/user/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The following colors are supported. Note that to target the default (gray) hat y
6666

6767
You can enable or disable colors in your VSCode settings, by searching for `cursorless.hatEnablement.colors` and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
6868

69-
You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes.
69+
You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. See our [visual accessibility guide](visualAccessibility.md) for more on visual accessibility.
7070

7171
If you find these color names unintuitive / tough to remember, their
7272
spoken forms can be [customized](customization.md) like any other spoken form

docs/user/visualAccessibility.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Visual Accessibility
2+
3+
Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. The primary visual elements of Cursorless are the [hats](./README.md#decorated-symbol), so this guide will focus on customizing the hats.
4+
5+
## Make the hats bigger
6+
7+
Say `"cursorless settings"` and find the `cursorless.hatSize` setting. This setting allows you to increase the size of the hats. You may need to change the vertical offset of the hats to keep them from clipping the line below / above.
8+
9+
You may also want to increase your line height to allow you to make the hats even larger: say `"show settings say line height"` and increase the line height to your preference.
10+
11+
A reasonable place to start is to set the line height to 1.6 and the hat size to 70.
12+
13+
## Use shapes instead of colors
14+
15+
If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable shapes instead. You can do so by saying `"cursorless settings"` and finding the `cursorless.hatEnablement.colors` and `cursorless.hatEnablement.shapes` settings.
16+
17+
## Tweak your color scheme
18+
19+
You can change the colors of the hats by saying `"cursorless settings"` and finding the `cursorless.colors.light` and `cursorless.colors.dark` settings.
20+
21+
There are several user-created color schemes available [on the Cursorless wiki](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes). One notable color scheme is the [Greyscale for Night Owl theme](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes#greyscale-for-night-owl-theme), which is designed to reduce visual stimulation and be compatible with most forms of color blindness. Instead of colors like "yellow", "green", etc, it uses "bright" and "dark". Here's how you use it:
22+
23+
1. Say `"cursorless settings"` and find the `cursorless.colors.light` or `cursorless.colors.dark` settings depending on your preferred mode
24+
1. Change your `default` color to `#848384`
25+
1. Change your `blue` color to `#ffffff`
26+
1. Change your `green` color to `#333333`
27+
1. Disable the other colors using the `cursorless.hatEnablement.colors` setting
28+
1. Change spoken forms within your Cursorless settings folder located at `cursorless-settings/hat_styles.csv` so that you have `bright, blue` and `dark, green`. This is within your Talon configuration, not the IDE settings. This will change the spoken forms to match the new colors so that you can say eg `"take bright air"` to select the word "air" with a bright hat. See [Customization](./customization.md) for more information on how to change spoken forms.

0 commit comments

Comments
 (0)