Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SelectProps

Hierarchy

Index

Properties

Methods

Properties

Optional about

about?: string

Optional accessKey

accessKey?: string

Optional anchor

anchor?: PositionAnchor

The positioning configuration for how the listbox should be anchored to the select button.

Optional aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Optional aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

Optional aria-autocomplete

aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

Optional aria-busy

aria-busy?: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

Optional aria-checked

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

see

aria-pressed @see aria-selected.

Optional aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

see

aria-colindex.

Optional aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

see

aria-colcount @see aria-colspan.

Optional aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

see

aria-colindex @see aria-rowspan.

Optional aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

see

aria-owns.

Optional aria-current

aria-current?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

Optional aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

see

aria-labelledby

Optional aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

see

aria-describedby.

Optional aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

see

aria-hidden @see aria-readonly.

Optional aria-dropeffect

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

deprecated

in ARIA 1.1

Optional aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

see

aria-invalid @see aria-describedby.

Optional aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Optional aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

Optional aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

deprecated

in ARIA 1.1

Optional aria-haspopup

aria-haspopup?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Optional aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

see

aria-disabled.

Optional aria-invalid

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

see

aria-errormessage.

Optional aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Optional aria-label

aria-label?: string

Defines a string value that labels the current element.

see

aria-labelledby.

Optional aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

see

aria-describedby.

Optional aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

Optional aria-live

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Optional aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

Optional aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

Optional aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

Optional aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Optional aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

see

aria-controls.

Optional aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

Optional aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

see

aria-setsize.

Optional aria-pressed

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

see

aria-checked @see aria-selected.

Optional aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

see

aria-disabled.

Optional aria-relevant

aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

see

aria-atomic.

Optional aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

Optional aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

Optional aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

see

aria-rowindex.

Optional aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

see

aria-rowcount @see aria-rowspan.

Optional aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

see

aria-rowindex @see aria-colspan.

Optional aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

see

aria-checked @see aria-pressed.

Optional aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

see

aria-posinset.

Optional aria-sort

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

Optional aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

Optional aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

Optional aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

see

aria-valuetext.

Optional aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

Optional autoCapitalize

autoCapitalize?: string

Optional autoCorrect

autoCorrect?: string

Optional autoSave

autoSave?: string

Optional className

className?: string

Optional closeOnResize

closeOnResize?: boolean

Boolean if the select's listbox should not hide if the user resizes the browser while it is visible.

Optional closeOnScroll

closeOnScroll?: boolean

Boolean if the select's listbox should not hide if the user scrolls the page while it is visible.

Optional color

color?: string

Optional contentEditable

contentEditable?: Booleanish | "inherit"

Optional contextMenu

contextMenu?: string

Optional dangerouslySetInnerHTML

dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string

Optional datatype

datatype?: string

Optional defaultChecked

defaultChecked?: boolean

Optional dense

dense?: boolean

Boolean if the form components should be using the dense spec to reduce the sizing slightly.

Optional dir

dir?: string

Optional disableLeftAddon

disableLeftAddon?: boolean

Boolean if the Select's button display value should not attempt to extract a leftAddon from the current selected option to display.

Optional disableMovementChange

disableMovementChange?: boolean

Boolean if using the keyboard should not immediately trigger the onChange callback. When this is enabled, the onChange callback will only be called if the user clicks an item or presses the enter or space key.

Optional disabled

disabled?: boolean

Boolean if the select is currently disabled.

Optional displayLabelClassName

displayLabelClassName?: string

An optional className to apply to the current display value within the Select's button component.

Optional displayLabelStyle

displayLabelStyle?: CSSProperties

An optional style to apply to the current display value within the Select's button component.

Optional draggable

draggable?: Booleanish

Optional error

error?: boolean

Boolean if the text field should gain the error state and update the colors.

Optional getDisplayLabel

getDisplayLabel?: (option: ListboxOption, labelKey: string, includeLeft: boolean) => ReactNode

Type declaration

    • (option: ListboxOption, labelKey: string, includeLeft: boolean): ReactNode

    • A function that will get the display value for the Select field based on the current selected option. The default behavior will be to return null if an option is not currently selected so the placeholder text can be shown instead. If there is an option selected, it will:

      • get the option's label using the general getOptionLabel util
      • check if includeLeft is enabled and the option is an object with leftAddon
        • if there is a leftAddon, use the TextIconSpacing of the label + the icon or avatar.

      Parameters

      • option: ListboxOption

        The option to get a display label for

      • labelKey: string

        The key to use to extract a label from the option when it is an object

      • includeLeft: boolean

        Boolean if a leftAddon should be added with TextIconSpacing to the result.

      Returns ReactNode

      A renderable node to display in a Select field.

Optional getOptionId

getOptionId?: (baseId: string, index: number) => string

Type declaration

    • (baseId: string, index: number): string

    • The default way to generate a "unique" id for each option within the listbox by concatenating the current index with a base id.

      Note: The index will be incremented by 1 so the ids start from 1 instead of 0. This is so that it matches how paginated results work with aria-posinset

      • aria-setsize.

      Parameters

      • baseId: string

        The base id of the listbox.

      • index: number

        The current index of the option

      Returns string

      a "unique" id for the option

Optional getOptionLabel

getOptionLabel?: (option: ListboxOption, labelKey: string) => ReactNode

Type declaration

    • A function that will get the label for an option. The default behavior is to check if the option is an object. If it is, it'll use the labelKey property and fallback to the children property. If it is anything else, the option itself will be returned.

      This is used in both the select's button element to show the current value as well as rendering each option within the listbox component.

      Parameters

      • option: ListboxOption

        The option that should be converted into a renderable label element.

      • labelKey: string

        The object key to use to extract the label from an option object.

      Returns ReactNode

      a renderable label to display.

Optional getOptionValue

getOptionValue?: (item: unknown, valueKey?: string) => string

Type declaration

    • (item: unknown, valueKey?: string): string

    • The default implementation of the getItemValue search option that will attempt to "stringify" any unknown item as a string.

      internal

      Parameters

      • item: unknown

        The current item to transform

      • Optional valueKey: string

        The key to use that should hold the value if the item is an object

      Returns string

      the item as a string

Optional hidden

hidden?: boolean

id

id: string

The id for the select component. This is required for a11y and will be used to generate ids for the listbox and each option within the listbox.

Optional inline

inline?: boolean

Boolean if the component should be rendered inline with display: inline-flex instead of display: flex.

Optional inlist

inlist?: any

Optional inputMode

inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

see

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

Optional is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

see

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

Optional isLeftAddon

isLeftAddon?: boolean

Boolean if the left children should be wrapped in the TextFieldAddon component. This is enabled by default since this is normally the behavior that is desired so that icons can be positioned correctly.

Optional isRightAddon

isRightAddon?: boolean

Boolean if the right children should be wrapped in the TextFieldAddon component. This is enabled by default since this is normally the behavior that is desired so that icons can be positioned correctly.

Optional itemID

itemID?: string

Optional itemProp

itemProp?: string

Optional itemRef

itemRef?: string

Optional itemScope

itemScope?: boolean

Optional itemType

itemType?: string

Optional label

label?: ReactNode

An optional floating label to use with the select.

Optional labelClassName

labelClassName?: string

An optional className to apply to the label element.

Optional labelKey

labelKey?: string

A key to use that extracts the display label for an option from the options list. This will only be used if the option is an object and is passed to the getOptionLabel prop.

Optional labelStyle

labelStyle?: CSSProperties

An optional style to apply to the label element.

Optional lang

lang?: string

Optional leftChildren

leftChildren?: ReactNode

An optional addon to apply to the left of the text field. This should normally be an icon. This element will not have pointer events so it can be "clicked through" to focus the text field instead.

Optional listboxClassName

listboxClassName?: string

An optional className to apply to the listbox.

Optional listboxStyle

listboxStyle?: CSSProperties

An optional style to apply to the listbox.

Optional listboxWidth

listboxWidth?: PositionWidth

The sizing behavior for the listbox. It will default to have the same width as the select button, but it is also possible to either have the min-width be the width of the select button or just automatically determine the width.

The sizing behavior will always ensure that the left and right bounds of the listbox appear within the viewport.

Optional name

name?: string

An optional name to provide for the listbox that will be provided with the onChange callback.

Optional onAbort

onAbort?: ReactEventHandler<HTMLDivElement>

Optional onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLDivElement>

Optional onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLDivElement>

Optional onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>

Optional onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLDivElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>

Optional onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLDivElement>

Optional onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>

Optional onAuxClick

onAuxClick?: MouseEventHandler<HTMLDivElement>

Optional onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLDivElement>

Optional onBeforeInput

onBeforeInput?: FormEventHandler<HTMLDivElement>

Optional onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLDivElement>

Optional onBlur

onBlur?: FocusEventHandler<HTMLDivElement>

Optional onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLDivElement>

Optional onCanPlay

onCanPlay?: ReactEventHandler<HTMLDivElement>

Optional onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLDivElement>

Optional onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLDivElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>

onChange

onChange: ListboxChangeEventHandler
see

ListboxChangeEventHandler

Optional onChangeCapture

onChangeCapture?: FormEventHandler<HTMLDivElement>

Optional onClick

onClick?: MouseEventHandler<HTMLDivElement>

Optional onClickCapture

onClickCapture?: MouseEventHandler<HTMLDivElement>

Optional onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLDivElement>

Optional onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>

Optional onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLDivElement>

Optional onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>

Optional onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>

Optional onContextMenu

onContextMenu?: MouseEventHandler<HTMLDivElement>

Optional onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLDivElement>

Optional onCopy

onCopy?: ClipboardEventHandler<HTMLDivElement>

Optional onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLDivElement>

Optional onCut

onCut?: ClipboardEventHandler<HTMLDivElement>

Optional onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLDivElement>

Optional onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLDivElement>

Optional onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>

Optional onDrag

onDrag?: DragEventHandler<HTMLDivElement>

Optional onDragCapture

onDragCapture?: DragEventHandler<HTMLDivElement>

Optional onDragEnd

onDragEnd?: DragEventHandler<HTMLDivElement>

Optional onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLDivElement>

Optional onDragEnter

onDragEnter?: DragEventHandler<HTMLDivElement>

Optional onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLDivElement>

Optional onDragExit

onDragExit?: DragEventHandler<HTMLDivElement>

Optional onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLDivElement>

Optional onDragLeave

onDragLeave?: DragEventHandler<HTMLDivElement>

Optional onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLDivElement>

Optional onDragOver

onDragOver?: DragEventHandler<HTMLDivElement>

Optional onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLDivElement>

Optional onDragStart

onDragStart?: DragEventHandler<HTMLDivElement>

Optional onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLDivElement>

Optional onDrop

onDrop?: DragEventHandler<HTMLDivElement>

Optional onDropCapture

onDropCapture?: DragEventHandler<HTMLDivElement>

Optional onDurationChange

onDurationChange?: ReactEventHandler<HTMLDivElement>

Optional onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>

Optional onEmptied

onEmptied?: ReactEventHandler<HTMLDivElement>

Optional onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLDivElement>

Optional onEncrypted

onEncrypted?: ReactEventHandler<HTMLDivElement>

Optional onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLDivElement>

Optional onEnded

onEnded?: ReactEventHandler<HTMLDivElement>

Optional onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLDivElement>

Optional onError

onError?: ReactEventHandler<HTMLDivElement>

Optional onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLDivElement>

Optional onFocus

onFocus?: FocusEventHandler<HTMLDivElement>

Optional onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLDivElement>

Optional onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLDivElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

Optional onInput

onInput?: FormEventHandler<HTMLDivElement>

Optional onInputCapture

onInputCapture?: FormEventHandler<HTMLDivElement>

Optional onInvalid

onInvalid?: FormEventHandler<HTMLDivElement>

Optional onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLDivElement>

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLDivElement>

Optional onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>

Optional onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLDivElement>
deprecated

Optional onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>
deprecated

Optional onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLDivElement>

Optional onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>

Optional onLoad

onLoad?: ReactEventHandler<HTMLDivElement>

Optional onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLDivElement>

Optional onLoadStart

onLoadStart?: ReactEventHandler<HTMLDivElement>

Optional onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLDivElement>

Optional onLoadedData

onLoadedData?: ReactEventHandler<HTMLDivElement>

Optional onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>

Optional onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLDivElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>

Optional onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLDivElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

Optional onMouseDown

onMouseDown?: MouseEventHandler<HTMLDivElement>

Optional onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLDivElement>

Optional onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLDivElement>

Optional onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLDivElement>

Optional onMouseMove

onMouseMove?: MouseEventHandler<HTMLDivElement>

Optional onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>

Optional onMouseOut

onMouseOut?: MouseEventHandler<HTMLDivElement>

Optional onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLDivElement>

Optional onMouseOver

onMouseOver?: MouseEventHandler<HTMLDivElement>

Optional onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLDivElement>

Optional onMouseUp

onMouseUp?: MouseEventHandler<HTMLDivElement>

Optional onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLDivElement>

Optional onPaste

onPaste?: ClipboardEventHandler<HTMLDivElement>

Optional onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLDivElement>

Optional onPause

onPause?: ReactEventHandler<HTMLDivElement>

Optional onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLDivElement>

Optional onPlay

onPlay?: ReactEventHandler<HTMLDivElement>

Optional onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLDivElement>

Optional onPlaying

onPlaying?: ReactEventHandler<HTMLDivElement>

Optional onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLDivElement>

Optional onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLDivElement>

Optional onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerDown

onPointerDown?: PointerEventHandler<HTMLDivElement>

Optional onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLDivElement>

Optional onPointerEnterCapture

onPointerEnterCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLDivElement>

Optional onPointerLeaveCapture

onPointerLeaveCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerMove

onPointerMove?: PointerEventHandler<HTMLDivElement>

Optional onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerOut

onPointerOut?: PointerEventHandler<HTMLDivElement>

Optional onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerOver

onPointerOver?: PointerEventHandler<HTMLDivElement>

Optional onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLDivElement>

Optional onPointerUp

onPointerUp?: PointerEventHandler<HTMLDivElement>

Optional onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLDivElement>

Optional onProgress

onProgress?: ReactEventHandler<HTMLDivElement>

Optional onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLDivElement>

Optional onRateChange

onRateChange?: ReactEventHandler<HTMLDivElement>

Optional onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLDivElement>

Optional onReset

onReset?: FormEventHandler<HTMLDivElement>

Optional onResetCapture

onResetCapture?: FormEventHandler<HTMLDivElement>

Optional onScroll

onScroll?: UIEventHandler<HTMLDivElement>

Optional onScrollCapture

onScrollCapture?: UIEventHandler<HTMLDivElement>

Optional onSeeked

onSeeked?: ReactEventHandler<HTMLDivElement>

Optional onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLDivElement>

Optional onSeeking

onSeeking?: ReactEventHandler<HTMLDivElement>

Optional onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLDivElement>

Optional onSelect

onSelect?: ReactEventHandler<HTMLDivElement>

Optional onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLDivElement>

Optional onStalled

onStalled?: ReactEventHandler<HTMLDivElement>

Optional onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLDivElement>

Optional onSubmit

onSubmit?: FormEventHandler<HTMLDivElement>

Optional onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLDivElement>

Optional onSuspend

onSuspend?: ReactEventHandler<HTMLDivElement>

Optional onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLDivElement>

Optional onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLDivElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>

Optional onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLDivElement>

Optional onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>

Optional onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLDivElement>

Optional onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLDivElement>

Optional onTouchMove

onTouchMove?: TouchEventHandler<HTMLDivElement>

Optional onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>

Optional onTouchStart

onTouchStart?: TouchEventHandler<HTMLDivElement>

Optional onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLDivElement>

Optional onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLDivElement>

Optional onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>

Optional onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLDivElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>

Optional onWaiting

onWaiting?: ReactEventHandler<HTMLDivElement>

Optional onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLDivElement>

Optional onWheel

onWheel?: WheelEventHandler<HTMLDivElement>

Optional onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLDivElement>

options

options: readonly ListboxOption[]

The list of options to display within the listbox.

Optional placeholder

placeholder?: ReactNode

An optional placeholder text to show while the select is unvalued and is either currently focused or the label prop was not provided.

Optional portal

portal?: boolean

Boolean if the portal should be used.

Optional portalInto

portalInto?: PortalInto
see

PortalProps.into

Optional portalIntoId

portalIntoId?: string
see

PortalProps.intoId

Optional positionOptions

positionOptions?: CalculateFixedPositionOptions

Used to add any additional fixed positioning behavior.

example
positionOptions={{
  preventOverlap: true,
  disableSwapping: true,
}}
remarks

@since 5.1.6

Optional prefix

prefix?: string

Optional property

property?: string

Optional radioGroup

radioGroup?: string

Optional readOnly

readOnly?: boolean

Boolean if the select should act as a read only select field which just allows for all the options to be visible when toggled open.

Optional resource

resource?: string

Optional results

results?: number

Optional rightChildren

rightChildren?: ReactNode

An optional icon to display to the right of the select. This should normally be a dropdown icon to replace the native select's dropdown icon. If this is set to null, the native select's dropdown icon will be displayed instead.

This defaults to the IconProvider's dropdown icon from the @react-md/icon package.

Optional role

role?: AriaRole

Optional security

security?: string

Optional slot

slot?: string

Optional spellCheck

spellCheck?: Booleanish

Optional stretch

stretch?: boolean

Boolean if the component should gain flex: 1 1 auto; which is useful for full-width behavior within flex containers.

defaultvalue

false

remarks

@since 5.0.0

Optional style

style?: CSSProperties

Optional suppressContentEditableWarning

suppressContentEditableWarning?: boolean

Optional suppressHydrationWarning

suppressHydrationWarning?: boolean

Optional tabIndex

tabIndex?: number

Optional theme

theme?: FormTheme

The current theme type.

Optional title

title?: string

Optional translate

translate?: "yes" | "no"

Optional typeof

typeof?: string

Optional underlineDirection

underlineDirection?: FormUnderlineDirection

The current underline direction.

Optional unselectable

unselectable?: "on" | "off"

value

value: string

The listbox is a controlled component, so you will need to provide the current value and an onChange handler. The value must be a string and should be one of the option's values when something has been selected. If you want to have an "empty" select box to require the user to manually select something to be considered valid, you can set this to the empty string and it'll be considered "unvalued".

Optional valueKey

valueKey?: string

A key to use that extracts the value for the option from the options list. This will only be used if the option is an object and will be passed to the getOptionValue prop.

Optional vocab

vocab?: string

Methods

Optional isOptionDisabled

Generated using TypeDoc