diff --git a/docs/user/customization.md b/docs/user/customization.md index de5c0b90f..63317ba89 100644 --- a/docs/user/customization.md +++ b/docs/user/customization.md @@ -60,6 +60,21 @@ push down, editor.action.moveLinesDownAction Now when you say eg "push down air and bat", cursorless will first select the two tokens with a gray hat over the `a` and `b`, then issue the VSCode command `editor.action.moveLinesDownAction`, and then restore your original selection. +## Toggling "hat" display + +It is possible to show / hide the hats with a command. Keep in mind that many users, often after less than a week using Cursorless, find that their brain starts to tune out the hat display. Some start to miss them when they're gone 🥲 + +However, should you like to show / hide the hats within your editor, you can use the following approach. + +- Bring up the command pallet(`Shift + CMD + P` on Mac; `Shift + Ctrl + P` on Windows / Linux). +- Enter `cursorless.toggleDecorations` or type `Cursorless Toggle` to see the command in the dropdown. + +You should also be able to find the above command by saying `"please toggle"`. The same command can be repeated to turn the hats back on. + +While the hats are hidden, you will not be able to address any marks, eg `"take air"`. However, Cursorless will still recognize scopes, eg `"take funk"`. + +If you'd like to map a voice command to toggle the hats, have a look at https://youtu.be/oWUJyDgz63k + ## Cursorless public API Cursorless exposes a couple talon actions and captures that you can use to define your own custom command grammar leveraging cursorless targets.