Interface GroupProps<Option, IsMulti, Group>

Type Parameters

  • Option = unknown

  • IsMulti extends boolean = boolean

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

Hierarchy

Properties

Heading children className? clearValue cx data getStyles getValue hasValue headingProps innerProps isMulti isRtl label options selectOption selectProps setValue theme

Properties

Heading

Heading: ComponentType<GroupHeadingProps<Option, IsMulti, Group>>

Component to wrap the label, receives headingProps.

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: Group

The data of the group.

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

headingProps

headingProps: ForwardedHeadingProps<Option, Group>

Props to pass to Heading.

innerProps

innerProps: DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>

Props to be passed to the group element.

isMulti

isMulti: boolean

isRtl

isRtl: boolean

label

label: ReactNode

Label to be displayed in the heading component.

options

options: <internal>.Options<Option>

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

Settings

Member Visibility

Theme

Generated using TypeDoc