Interface OptionProps<Option, IsMulti, Group>

Type Parameters

  • Option = unknown

  • IsMulti extends boolean = boolean

  • Group extends GroupBase<Option> = GroupBase<Option>

Hierarchy

Properties

children className? clearValue cx data getStyles getValue hasValue innerProps innerRef isDisabled isFocused isMulti isRtl isSelected label options selectOption selectProps setValue theme type

Properties

children

children: ReactNode

The children to be rendered.

Optional className

className?: string

clearValue

clearValue: (() => void)

Type declaration

    • (): void

    • Returns void

cx

cx: CX

data

data: Option

The data of the selected option.

getStyles

getStyles: GetStyles<Option, IsMulti, Group>

Get the styles of a particular part of the select. Pass in the name of the property as the first argument, and the current props as the second argument. See the styles object for the properties available.

getValue

getValue: (() => <internal>.Options<Option>)

Type declaration

hasValue

hasValue: boolean

innerProps

innerProps: DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>

props passed to the wrapping element for the group.

innerRef

innerRef: ((instance: null | HTMLDivElement) => void)

Type declaration

    • (instance: null | HTMLDivElement): void

    • Inner ref to DOM Node

      Parameters

      • instance: null | HTMLDivElement

      Returns void

isDisabled

isDisabled: boolean

Whether the option is disabled.

isFocused

isFocused: boolean

Whether the option is focused.

isMulti

isMulti: boolean

isRtl

isRtl: boolean

isSelected

isSelected: boolean

Whether the option is selected.

label

label: string

Text to be displayed representing the option.

options

options: OptionsOrGroups<Option, Group>

selectOption

selectOption: ((newValue: Option) => void)

Type declaration

    • (newValue: Option): void

    • Parameters

      • newValue: Option

      Returns void

selectProps

selectProps: <internal>.Props<Option, IsMulti, Group>

setValue

setValue: ((newValue: OnChangeValue<Option, IsMulti>, action: SetValueAction, option?: Option) => void)

Type declaration

theme

theme: <internal>.Theme

type

type: "option"

Type is used by the menu to determine whether this is an option or a group. In the case of option this is always option. *

Settings

Member Visibility

Theme

Generated using TypeDoc