chore: Update autosuggest and select API docs

Reflect the option fields where the default filtering applies in the API docs.
cloudscape-design · Dec 13, 2022 · 0d5d310 · 0d5d310
1 parent 6a2e638
commit 0d5d310
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/src/__tests__/__snapshots__/documenter.test.ts.snap b/src/__tests__/__snapshots__/documenter.test.ts.snap
@@ -1456,7 +1456,7 @@ in a slight, visible lag when scrolling complex pages.",
 * \`manual\` - You will set up \`onChange\` or \`onLoadItems\` event listeners and filter options on your side or request
 them from server.
 By default the component will filter the provided \`options\` based on the value of the filtering input field.
-Only options that have a \`value\` or \`label\` that contains the input value as a substring
+Only options that have a \`value\`, \`label\`, \`description\` or \`labelTag\` that contains the input value as a substring
 are displayed in the list of options.
 
 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.",
 * \`manual\` - You will set up \`onChange\` or \`onLoadItems\` event listeners and filter options on your side or request
 them from server.
 By default the component will filter the provided \`options\` based on the value of the filtering input field.
-Only options that have a \`value\` or \`label\` that contains the input value as a substring
+Only options that have a \`value\`, \`label\`, \`description\` or \`labelTag\` that contains the input value as a substring
 are displayed in the list of options.
 
 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.",
 * \`manual\` - You will set up \`onChange\` or \`onLoadItems\` event listeners and filter options on your side or request
 them from server.
 By default the component will filter the provided \`options\` based on the value of the filtering input field.
-Only options that have a \`value\` or \`label\` that contains the input value as a substring
+Only options that have a \`value\`, \`label\`, \`description\` or \`labelTag\` that contains the input value as a substring
 are displayed in the list of options.
 
 If you set this property to \`manual\`, this default filtering mechanism is disabled and all provided \`options\` are

diff --git a/src/autosuggest/interfaces.ts b/src/autosuggest/interfaces.ts
@@ -59,7 +59,7 @@ export interface AutosuggestProps
    * them from server.
    *
    * By default the component will filter the provided `options` based on the value of the filtering input field.
-   * Only options that have a `value` or `label` that contains the input value as a substring
+   * Only options that have a `value`, `label`, `description` or `labelTag` that contains the input value as a substring
    * are displayed in the list of options.
    *
    * If you set this property to `manual`, this default filtering mechanism is disabled and all provided `options` are

diff --git a/src/select/interfaces.ts b/src/select/interfaces.ts
@@ -55,7 +55,7 @@ export interface BaseSelectProps
    * them from server.
    *
    * By default the component will filter the provided `options` based on the value of the filtering input field.
-   * Only options that have a `value` or `label` that contains the input value as a substring
+   * Only options that have a `value`, `label`, `description` or `labelTag` that contains the input value as a substring
    * are displayed in the list of options.
    *
    * If you set this property to `manual`, this default filtering mechanism is disabled and all provided `options` are