widenarrow-ui 2.4.2 → 2.4.3

package/lib/index.d.ts

@@ -772,19 +772,27 @@ interface ComboboxBaseProps {
      */
     selectedOptions?: Array<OptionItem>;
     /**
-     * Text in the input, to control it, e.g. to fetch options for it. Without it the Combobox keeps the
-     * text itself. When controlled, update it from `onInputChange`.
+     * Text in the input, to control it. Without it the Combobox keeps the text itself. When controlled,
+     * update it from `onInputChange`.
      */
     inputValue?: string;
     /**
-     * Called when the text in the input changes. Fetch new options for reason `'input'` only: `'reset'`
-     * and `'clear'` set the text to the selected option's label or empty it.
+     * Called when the text in the input changes, with the reason. To fetch options for what the user
+     * types, use `onSearchChange` instead: the text of a `'reset'` is the selected option's label, which
+     * isn't a search.
      */
     onInputChange?: (inputValue: string, reason: ComboboxInputChangeReason) => void;
+    /**
+     * Called with the text to search for: what the user types, and `''` when the search ends, which is when
+     * an option is picked, the value is cleared or the field is left. Use it to fetch options per search,
+     * together with `filterOptions={false}`. Going back to `''` brings back the initial options, so the list
+     * doesn't stay filtered by an old search the next time it opens.
+     */
+    onSearchChange?: (searchText: string) => void;
     /**
      * Filters the options by the typed text. By default an option is shown when its `text` contains the
      * typed text, ignoring case. Pass `false` when the options are already filtered, e.g. fetched for the
-     * typed text from a server.
+     * typed text from a server, with `onSearchChange`.
      */
     filterOptions?: ((options: OptionItem[], inputValue: string) => OptionItem[]) | false;
     /** Visible label, associated with the input. Also its accessible name unless `ariaLabel` is set. */