Skip to content

Commit ad139b7

Browse files
chore: update readme text (#235)
1 parent 7e46977 commit ad139b7

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,46 @@ This plugin for Blockly enables keyboard navigation. It is intended to
44
experiment with different actions that might help visually impaired and motor
55
impaired people navigate a Blockly workspace.
66

7+
Keyboard navigation and screenreader support are closely coupled. The Blockly
8+
team intends to add screenreader support incrementally in Q2 and Q3 of 2025,
9+
as we validate the general approach to navigation.
10+
11+
For more planning and timeline information please read the [January 29 timeline post
12+
on the wiki](https://github.com/google/blockly-keyboard-experimentation/wiki/Jan-29-Timeline).
13+
14+
## End-user instructions
15+
716
You can explore the current state of the plugin on the [test page](https://google.github.io/blockly-keyboard-experimentation/).
817

18+
To use keyboard navigation, click on the workspace or press tab until you
19+
reach the workspace.
20+
21+
Once browser focus is on the Blockly workspace, you can use arrow keys to
22+
move a **cursor** around the workspace. You can use keyboard shortcuts to
23+
take actions at the cursor.
24+
25+
For instance, you can move the cursor to a
26+
dropdown field and press the `Enter` key to edit the field.
27+
28+
The available actions depend on the cursor location. For instance, if the
29+
cursor is on a block you can copy it with `Ctrl + C`.
30+
31+
You can open the toolbox by pressing `T` or pressing `Tab` until the toolbox is
32+
highlighted. Just like the workspace, you can use the arrow keys to move around
33+
the toolbox and select a block. Pressing `Enter` will place the block at the
34+
cursor's location on the workspace.
35+
36+
If you don't know which actions are available at your cursor location, you
37+
can press `Ctrl + Enter` to open the context menu and see a list of actions.
38+
39+
### Giving feedback
40+
41+
If you use the test page and find a bug, please let us know by opening an issue
42+
on this repository! Include information about how to reproduce the bug, what
43+
the bad behaviour was, and what you expected it to do. The Blockly team will
44+
triage the bug and add it to the roadmap.
45+
46+
### Note on @blockly/keyboard-navigation plugin
947
There is also an [existing keyboard navigation plugin](https://www.npmjs.com/package/@blockly/keyboard-navigation). That plugin may be where
1048
a finalized version of keyboard navigation eventually lives. But for now, this
1149
is where experimentation will be done.

0 commit comments

Comments
 (0)