Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OptionProps<Option, IsMulti, Group>

Type parameters

Hierarchy

Index

Properties

children: ReactNode

The children to be rendered.

className?: string
cx: CX
data: Option

The data of the selected option.

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.

hasValue: boolean
innerProps: DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>

props passed to the wrapping element for the group.

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

Type declaration

    • (instance: null | HTMLDivElement): void
    • Inner ref to DOM Node

      Parameters

      • instance: null | HTMLDivElement

      Returns void

isDisabled: boolean

Whether the option is disabled.

isFocused: boolean

Whether the option is focused.

isMulti: boolean
isRtl: boolean
isSelected: boolean

Whether the option is selected.

label: string

Text to be displayed representing the option.

options: OptionsOrGroups<Option, Group>
selectProps: <internal>.Props<Option, IsMulti, Group>
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.

Methods

  • clearValue(): void
  • selectOption(newValue: Option): void

Generated using TypeDoc