Skip to content

Commit 5f5c1b0

Browse files
Andrew Leachiansan5653
Andrew Leach
andauthored
Update documentation
Co-authored-by: Ian Sanders <[email protected]>
1 parent 1ef750e commit 5f5c1b0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/index.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
export type ComboboxSettings = {
22
tabInsertsSuggestions?: boolean
3+
/**
4+
* Indicates the default behaviour for the first option when the list is shown:
5+
*
6+
* - `'none'`: Don't auto-select the first option at all.
7+
* - `'active'`: Place the first option in an 'active' state where it is not
8+
* selected (is not the `aria-activedescendant`) but will still be applied
9+
* if the user presses `Enter`. To select the second item, the user would
10+
* need to press the down arrow twice. This approach allows quick application
11+
* of selections without disrupting screen reader users.
12+
* - `'selected'`: Select the first item by navigating to it. This allows quick
13+
* application of selections and makes it faster to select the second item,
14+
* but can be disruptive or confusing for screen reader users.
15+
*/
316
firstOptionSelectionMode?: FirstOptionSelectionMode
417
scrollIntoViewOptions?: boolean | ScrollIntoViewOptions
518
}

0 commit comments

Comments
 (0)