You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6
Original file line number
Diff line number
Diff line change
@@ -300,25 +300,27 @@ A function that gets passed an object with the property `className` (`{ classNam
300
300
301
301
Type: `Function`
302
302
303
-
A function that receives no arguments and should return the text used in the dropdown to indicate that there are no results.
303
+
A function that receives no arguments and returns the text used in the dropdown to indicate that there are no results.
304
304
305
305
#### `tStatusQueryTooShort` (default: `` (minQueryLength) => `Type in ${minQueryLength} or more characters for results` ``)
306
306
307
307
Type: `Function`
308
308
309
-
A function that receives one argument that indicates the minimal amount of characters needed for the dropdown to trigger and should return the text used in the accessibility hint to indicate that the query is too short.
309
+
A function that receives one argument that indicates the minimal amount of characters needed for the dropdown to trigger and returns the text used in the accessibility hint to indicate that the query is too short.
A function that receives no arguments and should return the text that is used in the accessibility hint to indicate that there are no results.
315
+
A function that receives no arguments and returns the text that is used in the accessibility hint to indicate that there are no results.
316
316
317
317
#### `tStatusSelectedOption` (default: `` (selectedOption, length, index) => `${selectedOption} ${index + 1} of ${length} is highlighted` ``)
318
318
319
319
Type: `Function`
320
320
321
-
A function that receives two arguments, the selectedOption and the amount of available options, and it should return the text used in the accessibility hint to indicate which option is selected.
321
+
A function that receives three arguments -
322
+
the selectedOption, the count of available options, and the (zero-based) index of the selected option -
323
+
and returns the text used in the accessibility hint to indicate which option is selected.
322
324
323
325
#### `tStatusResults`
324
326
@@ -337,13 +339,13 @@ Default:
337
339
338
340
Type: `Function`
339
341
340
-
A function that receives two arguments, the count of available options and the return value of `tStatusSelectedOption`, and should return the text used in the accessibility hint to indicate which options are available and which is selected.
342
+
A function that receives two arguments - the count of available options and the return value of `tStatusSelectedOption` - and returns the text used in the accessibility hint to indicate which options are available and which is selected.
341
343
342
344
#### `tAssistiveHint` (default: `() => 'When autocomplete results are available use up and down arrows to review and enter to select. Touch device users, explore by touch or with swipe gestures.'`)
343
345
344
346
Type: `Function`
345
347
346
-
A function that receives no arguments and should return the text to be assigned as the aria description of the html `input` element, via the `aria-describedby` attribute.
348
+
A function that receives no arguments and returns the text to be assigned as the aria description of the html `input` element, via the `aria-describedby` attribute.
347
349
This text is intended as an initial instruction to the assistive tech user. The `aria-describedby` attribute is automatically removed once user input is detected, in order to reduce screen reader verbosity.
0 commit comments