Skip to content

Commit 00a0080

Browse files
Update docs regarding sidebar
1 parent d9d8533 commit 00a0080

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed
71 KB
Loading
Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# The Cursorless sidebar
22

3-
You can say `"bar cursorless"` to show the Cursorless sidebar. Currently, the sidebar just contains a section showing a list of all scopes, organized by whether they are present and supported in the active text editor. As you type, the list of present scopes will update in real time. Clicking on a scope will visualize it using the [scope visualizer](scope-visualizer.md). Note that for legacy scopes, we can't tell whether they are present in the active text editor, so we list them under a separate Legacy section. Clicking on these scopes will not visualize them, as we also don't support visualizing legacy scopes.
3+
You can say `"bar cursorless"` to show the Cursorless sidebar.
4+
5+
## Scopes
6+
7+
- List showing all scopes, organized by whether they are present and supported in the active text editor.
8+
- As you type or move your selection, the list of present scopes will update in real time.
9+
- Clicking on a scope will visualize it using the [scope visualizer](scope-visualizer.md).
10+
- Display the users custom spoken forms
11+
12+
### Scope icons
13+
14+
To find a scope that matches your current selection look for the following icons:
15+
16+
🎯 scope is equal to selection\
17+
📦 scope contains selection
18+
19+
![sidebar scopes](./images/sidebar-scopes.png)
20+
21+
## Tutorial
22+
23+
Interactive tutorial to learn Cursorless

0 commit comments

Comments
 (0)