Interface ControlProps<Option, IsMulti, Group>

Type Parameters

  • Option = unknown

  • IsMulti extends boolean = boolean

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

Hierarchy

Properties

children: ReactNode

Children to render.

className?: string
clearValue: (() => void)

Type declaration

    • (): void
    • Returns void

cx: CX
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: (() => <internal>.Options<Option>)

Type declaration

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

The mouse down event and the innerRef to pass down to the controller element.

innerRef: <internal>.Ref<HTMLDivElement>
isDisabled: boolean

Whether the select is disabled.

isFocused: boolean

Whether the select is focused.

isMulti: boolean
isRtl: boolean
menuIsOpen: boolean

Whether the select is expanded.

options: OptionsOrGroups<Option, Group>
selectOption: ((newValue: Option) => void)

Type declaration

    • (newValue: Option): void
    • Parameters

      • newValue: Option

      Returns void

selectProps: <internal>.Props<Option, IsMulti, Group>
setValue: ((newValue: OnChangeValue<Option, IsMulti>, action: SetValueAction, option?: Option) => void)

Type declaration

Generated using TypeDoc