Interface UseSelectProps

Hierarchy

  • UsePopperProps

    Hierarchy

Properties

arrowPadding? boundary? create? direction? disabled? duplicates? enabled? eventListeners? filterFn? flip? getDebounce? getOption? gutter? matchWidth? modifiers? offset? onChange options? placeholder? placement? preventOverflow? scrollToIndex? searchPlaceholder? selectionVisibleIn? shiftAmount? single? size? stateReducer? strategy? value?

Properties

Optional arrowPadding

arrowPadding?: number

The padding required to prevent the arrow from reaching the very edge of the popper.

Default

8

Optional boundary

boundary?: HTMLElement | "clippingParents" | "scrollParent"

The boundary area for the popper. Used within the preventOverflow modifier

Default

"clippingParents"

Optional create

create?: boolean

Optional direction

direction?: "ltr" | "rtl"

Theme direction ltr or rtl. Popper's placement will be set accordingly

Default

"ltr"

Optional disabled

disabled?: boolean

Optional duplicates

duplicates?: boolean

Optional enabled

enabled?: boolean

Whether the popper.js should be enabled

Optional eventListeners

eventListeners?: boolean | { resize?: boolean; scroll?: boolean }

If provided, determines whether the popper will reposition itself on scroll and resize of the window.

Default

true

Optional filterFn

filterFn?: SelectFilter

Optional flip

flip?: boolean

If true, the popper will change its placement and flip when it's about to overflow its boundary area.

Default

true

Optional getDebounce

getDebounce?: GetDebounce

Optional getOption

getOption?: GetOption

Optional gutter

gutter?: number

The distance or margin between the reference and popper. It is used internally to create an offset modifier.

NB: If you define offset prop, it'll override the gutter.

Default

8

Optional matchWidth

matchWidth?: boolean

If true, the popper will match the width of the reference at all times. It's useful for autocomplete, date-picker and select patterns.

Optional modifiers

modifiers?: Partial<Modifier<string, any>>[]

Array of popper.js modifiers. Check the docs to see the list of possible modifiers you can pass.

See

Docs https://popper.js.org/docs/v2/modifiers/

Optional offset

offset?: [number, number]

The main and cross-axis offset to displace popper element from its reference element.

onChange

onChange: SelectOnChange

Optional options

options?: Option[]

Optional placeholder

placeholder?: string

Optional placement

placement?: PlacementWithLogical

The placement of the popper relative to its reference.

Default

"bottom"

Optional preventOverflow

preventOverflow?: boolean

If true, will prevent the popper from being cut off and ensure it's visible within the boundary area.

Default

true

Optional scrollToIndex

scrollToIndex?: ScrollToIndex

Optional searchPlaceholder

searchPlaceholder?: string

Optional selectionVisibleIn

selectionVisibleIn?: SelectionVisibilityMode

Optional shiftAmount

shiftAmount?: number

Optional single

single?: boolean

Optional size

size?: "sm" | "md" | "lg"

Optional stateReducer

stateReducer?: StateReducer

Optional strategy

strategy?: "fixed" | "absolute"

The CSS positioning strategy to use.

Default

"absolute"

Optional value

value?: any

Settings

Member Visibility

Theme

Generated using TypeDoc