@worldresources/wri-design-systems 2.211.3 → 2.212.1

package/dist/index.d.ts

@@ -134,6 +134,11 @@ type ComboboxLabels = {
     noItemsFoundLabel: ReactNodeLabel;
     /** Builds the visible text for the create-new-option row. Default: (inputValue) => `Create “${inputValue}”` */
     createOptionLabel: (inputValue: string) => ReactNodeLabel;
+    /**
+     * Visually hidden text announced while the dropdown is loading. Rendered as
+     * JSX child of the loading status element. Default: "Loading"
+     */
+    loadingLabel: ReactNodeLabel;
 };
 /** Labels for CloseButton internal UI strings. */
 type CloseButtonLabels = {
@@ -1237,6 +1242,17 @@ type ComboboxItem = {
     value: string;
 };
 type ComboboxProps = {
+    /**
+     * Dropdown options for both static lists and dynamically updated results.
+     * Changes to the list contents replace the dropdown options.
+     * @default []
+     */
+    items?: ComboboxItem[];
+    /**
+     * Legacy dropdown options, read only on mount when `items` is omitted.
+     * @deprecated Pass the options through `items` instead.
+     * @default []
+     */
     initialItems?: ComboboxItem[];
     label?: string;
     required?: boolean;
@@ -1260,15 +1276,32 @@ type ComboboxProps = {
     /** Called with the selected values whenever the selection changes. */
     onChange?: (values: string[]) => void;
     /**
-     * Whether the user can create options that do not exist in `initialItems`.
+     * Whether the user can create options that do not exist in the item list.
      * When `true`, typing a non-matching value shows a "Create …" row that adds
      * the entry to the list on selection.
      * @default false
      */
     creatable?: boolean;
+    /**
+     * Called with the current input text on every change, including the empty
+     * string when the input resets after a selection or clear (use it to restore
+     * the full list). Providing this
+     * callback enables server-side filtering mode: the built-in client-side
+     * filtering is skipped and the rendered list is whatever `items` currently
+     * contains, so the consumer can fetch matching items and pass them back via
+     * the `items` prop.
+     */
+    onQueryChange?: (query: string) => void;
+    /**
+     * Shows a loading spinner inside the dropdown and hides the "No items
+     * found" empty state. Intended for server-side filtering mode while a
+     * request triggered by `onQueryChange` is in flight.
+     * @default false
+     */
+    isLoading?: boolean;
 };
 
-declare const Combobox: ({ label, required, caption, errorMessage, size, disabled, showOptionalLabel, placeholder, labels, noMarginBottom, initialItems, multiple, showSelectedItems, value: controlledValue, defaultValue, onChange, creatable, }: ComboboxProps) => _emotion_react_jsx_runtime.JSX.Element;
+declare const Combobox: ({ label, required, caption, errorMessage, size, disabled, showOptionalLabel, placeholder, labels, noMarginBottom, items, initialItems, multiple, showSelectedItems, value: controlledValue, defaultValue, onChange, creatable, onQueryChange, isLoading, }: ComboboxProps) => _emotion_react_jsx_runtime.JSX.Element;
 
 type TagProps = Omit<Tag$1.RootProps, 'size' | 'variant' | 'colorPalette' | 'children'> & {
     label: string;