platform-bible-react
    Preparing search index...

    Type Alias ComboBoxProps<T>

    ComboBoxProps: {
        alignDropDown?: "start" | "center" | "end";
        ariaLabel?: string;
        buttonClassName?: string;
        buttonPlaceholder?: string;
        buttonVariant?: ButtonProps["variant"];
        className?: string;
        commandEmptyMessage?: string;
        getButtonLabel?: (option: T) => string;
        getOptionLabel?: (option: T) => string;
        icon?: ReactNode;
        id?: string;
        isDisabled?: boolean;
        onChange?: (newValue: T) => void;
        options?: readonly T[] | readonly ComboBoxGroup<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

    • OptionalariaLabel?: string

      Optional aria-label for the trigger button for accessibility

    • 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

      3 December 2024. Renamed to buttonClassName

    • OptionalcommandEmptyMessage?: string

      Text to display when no options match input

    • OptionalgetButtonLabel?: (option: T) => string

      Used to determine the string value to display on the button for the selected value. If not provided, falls back to getOptionLabel.

    • OptionalgetOptionLabel?: (option: T) => 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[] | readonly ComboBoxGroup<T>[]

      List of available options for the dropdown menu. Can be either:

      • A flat array of options (single group, no heading)
      • An array of group objects. Each group has a heading and an array of options
    • 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