Skip to content

Document the 'select item' list event. #380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fadedbee wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document the 'select item' list event. #380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -831,7 +831,8 @@ A scrollable list which can display selectable items.
##### Events:

- Inherits all from Box.
- __select__ - Received when an item is selected.
- __select__ - Received when an item is actively selected, by clicking, pressing return, or similar.
- __select item__ - Received an item is incidentally selected, by using the arrow keys or mouse wheel.
- __cancel__ - List was canceled (when `esc` is pressed with the `keys` option).
- __action__ - Either a select or a cancel event was received.

Expand Down