widenarrow-ui 2.4.5 → 2.4.6

package/lib/index.d.ts

@@ -680,6 +680,12 @@ interface OptionItem {
      * reported as a string instead, so a numeric `value` comes back as e.g. `'2'`.
      */
     value: string | number;
+    /**
+     * Context shown after `text` on the same line, in a lighter colour, e.g. where a topic sits in a taxonomy.
+     * Matched by the Combobox's default filter. Not shown in pills or in the field, which show `text` only.
+     * With `nativeHtmlComponent`, shown in parentheses after `text`.
+     */
+    secondaryText?: string;
     /** Renders the option but prevents it from being picked. @default false */
     disabled?: boolean;
     /**
@@ -752,8 +758,13 @@ interface SelectInputProps {
      * @default false
      */
     nativeHtmlComponent?: boolean;
-    /** Size from the smallest breakpoint up. @default SizeTypes.MEDIUM */
+    /** Size of the field, and of the list unless `listSize` is set. @default SizeTypes.MEDIUM */
     size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
+    /**
+     * Size of the options in the list, when it should differ from the field's. Without it the list follows
+     * `size`, with medium options for a large field.
+     */
+    listSize?: SizeTypes.SMALL | SizeTypes.MEDIUM;
     /** Adds bottom spacing, for stacking fields in a form. @default false */
     marginBottom?: boolean;
     /** Focus the select on mount. @default false */
@@ -799,8 +810,8 @@ interface ComboboxBaseProps {
      */
     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
+     * Filters the options by the typed text. By default an option is shown when its `text` or
+     * `secondaryText` contains the typed text, ignoring case. Pass `false` when the options are already filtered, e.g. fetched for the
      * typed text from a server, with `onSearchChange`.
      */
     filterOptions?: ((options: OptionItem[], inputValue: string) => OptionItem[]) | false;
@@ -851,8 +862,13 @@ interface ComboboxBaseProps {
      * The list is not affected. Without it, the input looks like the other form fields.
      */
     type?: HierarchyTypes.PRIMARY | HierarchyTypes.SECONDARY;
-    /** @default SizeTypes.MEDIUM */
+    /** Size of the field, and of the list unless `listSize` is set. @default SizeTypes.MEDIUM */
     size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
+    /**
+     * Size of the options in the list, when it should differ from the field's. Without it the list follows
+     * `size`, with medium options for a large field.
+     */
+    listSize?: SizeTypes.SMALL | SizeTypes.MEDIUM;
     /** Adds bottom spacing, for stacking fields in a form. @default false */
     marginBottom?: boolean;
     /** Focus the input on mount. @default false */
@@ -867,6 +883,8 @@ interface ComboboxBaseProps {
     className?: string;
     /** Class name of the `<input>`. */
     inputClassName?: string;
+    /** Class name of the field around the input and the pills, e.g. to attach another element to it. */
+    fieldClassName?: string;
 }
 interface ComboboxSingleProps extends ComboboxBaseProps {
     /**
@@ -2092,7 +2110,7 @@ declare const TabGroup: {
 };
 
 declare const SelectInput: {
-    ({ label, withLabel, inputRef, nativeHtmlComponent, size, ariaLabel, id, onChange, defaultOption, value, error, autoFocus, helperText, options, disabled, loading, name, className, inputClassName, marginBottom }: SelectInputProps): JSX.Element;
+    ({ label, withLabel, inputRef, nativeHtmlComponent, size, listSize, ariaLabel, id, onChange, defaultOption, value, error, autoFocus, helperText, options, disabled, loading, name, className, inputClassName, marginBottom }: SelectInputProps): JSX.Element;
     displayName: string;
 };