Type Alias ComboBoxProps<T>

ComboBoxProps: {
    alignDropDown?: "start" | "center" | "end";
    buttonClassName?: string;
    buttonPlaceholder?: string;
    buttonVariant?: ButtonProps["variant"];
    className?: string;
    commandEmptyMessage?: string;
    getOptionLabel?: (option: ComboBoxOption) => string;
    icon?: ReactNode;
    id?: string;
    isDisabled?: boolean;
    onChange?: (newValue: T) => void;
    options?: readonly T[];
    popoverContentClassName?: string;
    textPlaceholder?: string;
    value?: T;
} & PopoverProps

Type Parameters

  • T

Type declaration

  • OptionalalignDropDown?: "start" | "center" | "end"

    Control how the popover menu should be aligned. Defaults to start

  • OptionalbuttonClassName?: string

    Additional css classes to help with unique styling of the combo box button

  • OptionalbuttonPlaceholder?: string

    Text displayed on button if value is undefined

  • OptionalbuttonVariant?: ButtonProps["variant"]

    Variant of button

  • OptionalclassName?: string

    Deprecated

    3 December 2024. Renamed to buttonClassName

  • OptionalcommandEmptyMessage?: string

    Text to display when no options match input

  • OptionalgetOptionLabel?: (option: ComboBoxOption) => string

    Used to determine the string value for a given option.

  • Optionalicon?: ReactNode

    Icon to be displayed on the trigger

  • Optionalid?: string

    Optional unique identifier

  • OptionalisDisabled?: boolean

    Optional boolean to set if trigger should be disabled

  • OptionalonChange?: (newValue: T) => void

    Triggers when content of textfield is changed

  • Optionaloptions?: readonly T[]

    List of available options for the dropdown menu

  • OptionalpopoverContentClassName?: string

    Additional css classes to help with unique styling of the combo box popover

  • OptionaltextPlaceholder?: string

    Placeholder text for text field

  • Optionalvalue?: T

    The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

Settings

Member Visibility