Skip to content

Commit 0d5d310

Browse files
Johannes Weberjohannes-weber
Johannes Weber
authored andcommitted
chore: Update autosuggest and select API docs
Reflect the option fields where the default filtering applies in the API docs.
1 parent 6a2e638 commit 0d5d310

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

src/__tests__/__snapshots__/documenter.test.ts.snap

+3-3
Original file line numberDiff line numberDiff line change
@@ -1456,7 +1456,7 @@ in a slight, visible lag when scrolling complex pages.",
14561456
* \`manual\` - You will set up \`onChange\` or \`onLoadItems\` event listeners and filter options on your side or request
14571457
them from server.
14581458
By default the component will filter the provided \`options\` based on the value of the filtering input field.
1459-
Only options that have a \`value\` or \`label\` that contains the input value as a substring
1459+
Only options that have a \`value\`, \`label\`, \`description\` or \`labelTag\` that contains the input value as a substring
14601460
are displayed in the list of options.
14611461

14621462
If you set this property to \`manual\`, this default filtering mechanism is disabled and all provided \`options\` are
@@ -7669,7 +7669,7 @@ in a slight, visible lag when scrolling complex pages.",
76697669
* \`manual\` - You will set up \`onChange\` or \`onLoadItems\` event listeners and filter options on your side or request
76707670
them from server.
76717671
By default the component will filter the provided \`options\` based on the value of the filtering input field.
7672-
Only options that have a \`value\` or \`label\` that contains the input value as a substring
7672+
Only options that have a \`value\`, \`label\`, \`description\` or \`labelTag\` that contains the input value as a substring
76737673
are displayed in the list of options.
76747674

76757675
If you set this property to \`manual\`, this default filtering mechanism is disabled and all provided \`options\` are
@@ -10037,7 +10037,7 @@ in a slight, visible lag when scrolling complex pages.",
1003710037
* \`manual\` - You will set up \`onChange\` or \`onLoadItems\` event listeners and filter options on your side or request
1003810038
them from server.
1003910039
By default the component will filter the provided \`options\` based on the value of the filtering input field.
10040-
Only options that have a \`value\` or \`label\` that contains the input value as a substring
10040+
Only options that have a \`value\`, \`label\`, \`description\` or \`labelTag\` that contains the input value as a substring
1004110041
are displayed in the list of options.
1004210042

1004310043
If you set this property to \`manual\`, this default filtering mechanism is disabled and all provided \`options\` are

src/autosuggest/interfaces.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export interface AutosuggestProps
5959
* them from server.
6060
*
6161
* By default the component will filter the provided `options` based on the value of the filtering input field.
62-
* Only options that have a `value` or `label` that contains the input value as a substring
62+
* Only options that have a `value`, `label`, `description` or `labelTag` that contains the input value as a substring
6363
* are displayed in the list of options.
6464
*
6565
* If you set this property to `manual`, this default filtering mechanism is disabled and all provided `options` are

src/select/interfaces.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export interface BaseSelectProps
5555
* them from server.
5656
*
5757
* By default the component will filter the provided `options` based on the value of the filtering input field.
58-
* Only options that have a `value` or `label` that contains the input value as a substring
58+
* Only options that have a `value`, `label`, `description` or `labelTag` that contains the input value as a substring
5959
* are displayed in the list of options.
6060
*
6161
* If you set this property to `manual`, this default filtering mechanism is disabled and all provided `options` are

0 commit comments

Comments
 (0)