cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-04 21:07:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add docs to cover toggling hats (#733)

Browse Source 
* Add docs to cover toggling hats

* Update docs/user/customization.md

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update docs/user/customization.md

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update docs/user/customization.md

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Will Sommers 2022-06-08 09:54:07 -04:00 committed by GitHub
parent f9b1bf05ea
commit 33d0a8fe26
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/user/customization.md
View File

@ -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.