gantri-components 2.184.1 → 2.185.0-beta.1

package/dist/components/search-field/search-field.types.d.ts

@@ -8,14 +8,13 @@ import { Maybe } from '../../global';
 import { ResolutionAwareProp } from '../../types/resolution-aware-prop.type';
 import { TextVariant } from '../typography';
 import { TooltipProps } from '../tooltip/tooltip.types';
+import { IconProps } from '../icon/icon.types';
 export interface SearchFieldProps<T extends DynamicListItem<Record<any, any> & {
     isAddTag?: boolean;
 }>> extends Omit<DropdownMenuProps<T>, 'items'> {
     borderless?: boolean;
     className?: string;
     clearButtonText?: string;
-    /** Create new [creatableLabel]: “tim” */
-    creatableLabel?: string;
     disabled?: boolean;
     /** Applies to any disabled tooltips within the dropdown menu. */
     disabledTooltipProps?: Partial<TooltipProps>;
@@ -26,9 +25,7 @@ export interface SearchFieldProps<T extends DynamicListItem<Record<any, any> & {
     filterFn?: (searchBy: string, item: T) => boolean;
     hideErrors?: boolean;
     icon?: ReactElement;
-    isCreatable?: boolean;
-    /** function to determine if the creatable query string is valid to show the creatable dropdown option */
-    isValidCreatableItem?: (query: string) => boolean;
+    isCreatable?: SearchFieldIsCreatableDef;
     /** Can optionally include `disabled: true` to any index to disable that item. */
     items?: DynamicListItem<T>[];
     keyProperty?: (option?: DynamicListItem<T>) => string;
@@ -64,9 +61,23 @@ export interface SearchFieldProps<T extends DynamicListItem<Record<any, any> & {
      * the new items must be provided after.
      * */
     searchMode?: 'internal' | 'external';
-    /** The initial values for the selected items list. */
+    /**
+     * The initial values for the selected items list.
+     *
+     * Not compatible with externally filtering available `items`.
+     */
     selectedItemsList?: T[keyof T][];
     size?: ResolutionAwareProp<TextFieldSize>;
     style?: CSSProperties;
     variant?: 'line' | 'filled';
 }
+export interface SearchFieldIsCreatableDef {
+    addToSelectedItemsOnCreate?: boolean;
+    enabled: boolean;
+    iconColor?: IconProps['color'];
+    iconName?: IconProps['name'];
+    /** Function to determine if the creatable query string is valid to show the creatable dropdown option */
+    isValid?: (query: string) => boolean;
+    /** Override label text that appears next to the creatable item. */
+    label?: string;
+}