Interface RegionSearchProps

Hierarchy

Properties

ChipProps? ListboxComponent? ListboxProps? PaperComponent? PopperComponent? about? accessKey? aria-activedescendant? aria-atomic? aria-autocomplete? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colspan? aria-controls? aria-current? aria-describedby? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoComplete? autoCorrect? autoHighlight? autoSave? autoSelect? blurOnSelect? className? classes? clearIcon? clearOnBlur? clearOnEscape? clearText? closeText? color? componentName? componentsProps? contentEditable? contextMenu? dangerouslySetInnerHTML? datatype? defaultChecked? defaultValue? dir? disableClearable? disableCloseOnSelect? disableListWrap? disablePortal? disabled? disabledItemsFocusable? draggable? filterOptions? filterSelectedOptions? forcePopupIcon? freeSolo? fullWidth? getLimitTagsText? getOptionDisabled? getOptionLabel? groupBy? handleHomeEndKeys? hidden? id? includeInputInList? inlist? inputLabel? inputMode? inputValue? is? isOptionEqualToValue? itemID? itemProp? itemRef? itemScope? itemType? lang? limitTags? loading? loadingText? multiple? noOptionsText? nonce? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onClose? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onHighlightChange? onInput? onInputCapture? onInputChange? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadStart? onLoadStartCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onOpen? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerEnterCapture? onPointerLeave? onPointerLeaveCapture? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionEnd? onTransitionEndCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? open? openOnFocus? openText? options placeholder? popupIcon? prefix? property? radioGroup? readOnly? ref? regionDB renderGroup? renderInput? renderOption? renderTags? resource? results? role? security? selectOnFocus? size? slot? slotProps? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? sx? tabIndex? title? translate? typeof? unselectable? unstable_classNamePrefix? unstable_isActiveElementInListbox? value? vocab?

Properties

Optional ChipProps

ChipProps?: ChipProps<"div", {}>

Props applied to the Chip element.

Optional ListboxComponent

ListboxComponent?: JSXElementConstructor<HTMLAttributes<HTMLElement>>

The component used to render the listbox.

Default

'ul'

Optional ListboxProps

ListboxProps?: HTMLAttributes<HTMLUListElement>

Props applied to the Listbox element.

Optional PaperComponent

PaperComponent?: JSXElementConstructor<HTMLAttributes<HTMLElement>>

The component used to render the body of the popup.

Default

Paper

Optional PopperComponent

PopperComponent?: JSXElementConstructor<PopperProps>

The component used to position the popup.

Default

Popper

Optional about

about?: string

Optional accessKey

accessKey?: string

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?: "none" | "both" | "inline" | "list"

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
  • 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
  • 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
  • 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 | "date" | "true" | "false" | "page" | "time" | "step" | "location"

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
  • aria-readonly.

Optional aria-dropeffect

aria-dropeffect?: "none" | "copy" | "move" | "link" | "execute" | "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
  • 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" | "listbox" | "grid" | "menu" | "dialog" | "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
  • 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?: "all" | "text" | "additions" | "additions removals" | "additions text" | "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
  • 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
  • aria-colspan.

Optional aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • 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 autoComplete

autoComplete?: boolean

If true, the portion of the selected suggestion that has not been typed by the user, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.

Default

false

Optional autoCorrect

autoCorrect?: string

Optional autoHighlight

autoHighlight?: boolean

If true, the first option is automatically highlighted.

Default

false

Optional autoSave

autoSave?: string

Optional autoSelect

autoSelect?: boolean

If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.

Default

false

Optional blurOnSelect

blurOnSelect?: boolean | "touch" | "mouse"

Control if the input should be blurred when an option is selected:

  • false the input is not blurred.
  • true the input is always blurred.
  • touch the input is blurred after a touch event.
  • mouse the input is blurred after a mouse event.

Default

false

Optional className

className?: string

Optional classes

classes?: Partial<AutocompleteClasses>

Override or extend the styles applied to the component.

Optional clearIcon

clearIcon?: ReactNode

The icon to display in place of the default clear icon.

Default

Optional clearOnBlur

clearOnBlur?: boolean

If true, the input's text is cleared on blur if no value is selected.

Set to true if you want to help the user enter a new value. Set to false if you want to help the user resume their search.

Default

!props.freeSolo

Optional clearOnEscape

clearOnEscape?: boolean

If true, clear all values when the user presses escape and the popup is closed.

Default

false

Optional clearText

clearText?: string

Override the default text for the clear icon button.

For localization purposes, you can use the provided translations.

Default

'Clear'

Optional closeText

closeText?: string

Override the default text for the close popup icon button.

For localization purposes, you can use the provided translations.

Default

'Close'

Optional color

color?: string

Optional componentName

componentName?: string

The component name that is using this hook. Used for warnings.

Optional componentsProps

componentsProps?: {
    clearIndicator?: Partial<IconButtonProps<"button", {}>>;
    paper?: PaperProps<"div", {}>;
    popper?: Partial<PopperProps>;
    popupIndicator?: Partial<IconButtonProps<"button", {}>>;
}

The props used for each slot inside.

Default

Type declaration

  • Optional clearIndicator?: Partial<IconButtonProps<"button", {}>>
  • Optional paper?: PaperProps<"div", {}>
  • Optional popper?: Partial<PopperProps>
  • Optional popupIndicator?: Partial<IconButtonProps<"button", {}>>

Optional contentEditable

contentEditable?: "inherit" | Booleanish

Optional contextMenu

contextMenu?: string

Optional dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
    __html: string;
}

Type declaration

  • __html: string

Optional datatype

datatype?: string

Optional defaultChecked

defaultChecked?: boolean

Optional defaultValue

defaultValue?: null | Region

The default value. Use when the component is not controlled.

Default

props.multiple ? [] : null

Optional dir

dir?: string

Optional disableClearable

disableClearable?: false

If true, the input can't be cleared.

Default

false

Optional disableCloseOnSelect

disableCloseOnSelect?: boolean

If true, the popup won't close when a value is selected.

Default

false

Optional disableListWrap

disableListWrap?: boolean

If true, the list box in the popup will not wrap focus.

Default

false

Optional disablePortal

disablePortal?: boolean

If true, the Popper content will be under the DOM hierarchy of the parent component.

Default

false

Optional disabled

disabled?: boolean

If true, the component is disabled.

Default

false

Optional disabledItemsFocusable

disabledItemsFocusable?: boolean

If true, will allow focus on disabled items.

Default

false

Optional draggable

draggable?: Booleanish

Optional filterOptions

filterOptions?: ((options: Region[], state: FilterOptionsState<Region>) => Region[])

Type declaration

    • (options: Region[], state: FilterOptionsState<Region>): Region[]

    • A function that determines the filtered options to be rendered on search.

      Returns

      Parameters

      • options: Region[]

        The options to render.

      • state: FilterOptionsState<Region>

        The state of the component.

      Returns Region[]

Optional filterSelectedOptions

filterSelectedOptions?: boolean

If true, hide the selected options from the list box.

Default

false

Optional forcePopupIcon

forcePopupIcon?: boolean | "auto"

Force the visibility display of the popup icon.

Default

'auto'

Optional freeSolo

freeSolo?: false

If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.

Default

false

Optional fullWidth

fullWidth?: boolean

If true, the input will take up the full width of its container.

Default

false

Optional getLimitTagsText

getLimitTagsText?: ((more: number) => ReactNode)

Type declaration

    • (more: number): ReactNode

    • The label to display when the tags are truncated (limitTags).

      Returns

      Default

      (more) => +${more}

      Parameters

      • more: number

        The number of truncated tags.

      Returns ReactNode

Optional getOptionDisabled

getOptionDisabled?: ((option: Region) => boolean)

Type declaration

    • (option: Region): boolean

    • Used to determine the disabled state for a given option.

      Returns

      Parameters

      • option: Region

        The option to test.

      Returns boolean

Optional getOptionLabel

getOptionLabel?: ((option: Region) => string)

Type declaration

    • (option: Region): string

    • Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).

      If used in free solo mode, it must accept both the type of the options and a string.

      Returns

      Default

      (option) => option.label ?? option

      Parameters

      Returns string

Optional groupBy

groupBy?: ((option: Region) => string)

Type declaration

    • (option: Region): string

    • If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

      Returns

      Parameters

      Returns string

Optional handleHomeEndKeys

handleHomeEndKeys?: boolean

If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively.

Default

!props.freeSolo

Optional hidden

hidden?: boolean

Optional id

id?: string

This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.

Optional includeInputInList

includeInputInList?: boolean

If true, the highlight can move to the input.

Default

false

Optional inlist

inlist?: any

Optional inputLabel

inputLabel?: string

Placeholder text displayed in the text field.

Default

"City, county, state, or district"

Optional inputMode

inputMode?: "text" | "none" | "search" | "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 inputValue

inputValue?: string

The input value.

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 isOptionEqualToValue

isOptionEqualToValue?: ((option: Region, value: Region) => boolean)

Type declaration

    • (option: Region, value: Region): boolean

    • Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

      Returns

      Parameters

      • option: Region

        The option to test.

      • value: Region

        The value to test against.

      Returns boolean

Optional itemID

itemID?: string

Optional itemProp

itemProp?: string

Optional itemRef

itemRef?: string

Optional itemScope

itemScope?: boolean

Optional itemType

itemType?: string

Optional lang

lang?: string

Optional limitTags

limitTags?: number

The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.

Default

-1

Optional loading

loading?: boolean

If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).

Default

false

Optional loadingText

loadingText?: ReactNode

Text to display when in a loading state.

For localization purposes, you can use the provided translations.

Default

'Loading…'

Optional multiple

multiple?: false

If true, value must be an array and the menu will support multiple selections.

Default

false

Optional noOptionsText

noOptionsText?: ReactNode

Text to display when there are no options.

For localization purposes, you can use the provided translations.

Default

'No options'

Optional nonce

nonce?: string

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>

Optional onChange

onChange?: ((event: SyntheticEvent<Element, Event>, value: null | Region, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<Region>) => void)

Type declaration

    • (event: SyntheticEvent<Element, Event>, value: null | Region, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<Region>): void

    • Callback fired when the value changes.

      Parameters

      • event: SyntheticEvent<Element, Event>

        The event source of the callback.

      • value: null | Region

        The new value of the component.

      • reason: AutocompleteChangeReason

        One of "createOption", "selectOption", "removeOption", "blur" or "clear".

      • Optional details: AutocompleteChangeDetails<Region>

      Returns void

Optional onChangeCapture

onChangeCapture?: FormEventHandler<HTMLDivElement>

Optional onClick

onClick?: MouseEventHandler<HTMLDivElement>

Optional onClickCapture

onClickCapture?: MouseEventHandler<HTMLDivElement>

Optional onClose

onClose?: ((event: SyntheticEvent<Element, Event>, reason: AutocompleteCloseReason) => void)

Type declaration

    • (event: SyntheticEvent<Element, Event>, reason: AutocompleteCloseReason): void

    • Callback fired when the popup requests to be closed. Use in controlled mode (see open).

      Parameters

      • event: SyntheticEvent<Element, Event>

        The event source of the callback.

      • reason: AutocompleteCloseReason

        Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".

      Returns void

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 onHighlightChange

onHighlightChange?: ((event: SyntheticEvent<Element, Event>, option: null | Region, reason: AutocompleteHighlightChangeReason) => void)

Type declaration

    • (event: SyntheticEvent<Element, Event>, option: null | Region, reason: AutocompleteHighlightChangeReason): void

    • Callback fired when the highlight option changes.

      Parameters

      • event: SyntheticEvent<Element, Event>

        The event source of the callback.

      • option: null | Region

        The highlighted option.

      • reason: AutocompleteHighlightChangeReason

        Can be: "keyboard", "auto", "mouse".

      Returns void

Optional onInput

onInput?: FormEventHandler<HTMLDivElement>

Optional onInputCapture

onInputCapture?: FormEventHandler<HTMLDivElement>

Optional onInputChange

onInputChange?: ((event: SyntheticEvent<Element, Event>, value: string, reason: AutocompleteInputChangeReason) => void)

Type declaration

    • (event: SyntheticEvent<Element, Event>, value: string, reason: AutocompleteInputChangeReason): void

    • Callback fired when the input value changes.

      Parameters

      • event: SyntheticEvent<Element, Event>

        The event source of the callback.

      • value: string

        The new value of the text input.

      • reason: AutocompleteInputChangeReason

        Can be: "input" (user input), "reset" (programmatic change), "clear".

      Returns void

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 onOpen

onOpen?: ((event: SyntheticEvent<Element, Event>) => void)

Type declaration

    • (event: SyntheticEvent<Element, Event>): void

    • Callback fired when the popup requests to be opened. Use in controlled mode (see open).

      Parameters

      • event: SyntheticEvent<Element, Event>

        The event source of the callback.

      Returns void

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 onResize

onResize?: ReactEventHandler<HTMLDivElement>

Optional onResizeCapture

onResizeCapture?: ReactEventHandler<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>

Optional open

open?: boolean

If true, the component is shown.

Optional openOnFocus

openOnFocus?: boolean

If true, the popup will open on input focus.

Default

false

Optional openText

openText?: string

Override the default text for the open popup icon button.

For localization purposes, you can use the provided translations.

Default

'Open'

options

options: readonly Region[]

Array of options.

Optional placeholder

placeholder?: string

Optional popupIcon

popupIcon?: ReactNode

The icon to display in place of the default popup icon.

Default

Optional prefix

prefix?: string

Optional property

property?: string

Optional radioGroup

radioGroup?: string

Optional readOnly

readOnly?: boolean

If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.

Default

false

Optional ref

ref?: Ref<unknown>

regionDB

regionDB: RegionDB

RegionDB instance to use.

Optional renderGroup

renderGroup?: ((params: AutocompleteRenderGroupParams) => ReactNode)

Type declaration

    • (params: AutocompleteRenderGroupParams): ReactNode

    • Render the group.

      Returns

      Parameters

      • params: AutocompleteRenderGroupParams

        The group to render.

      Returns ReactNode

Optional renderInput

renderInput?: ((params: AutocompleteRenderInputParams) => ReactNode)

Type declaration

Optional renderOption

renderOption?: ((props: HTMLAttributes<HTMLLIElement>, option: Region, state: AutocompleteRenderOptionState) => ReactNode)

Type declaration

    • (props: HTMLAttributes<HTMLLIElement>, option: Region, state: AutocompleteRenderOptionState): ReactNode

    • Render the option, use getOptionLabel by default.

      Returns

      Parameters

      • props: HTMLAttributes<HTMLLIElement>

        The props to apply on the li element.

      • option: Region

        The option to render.

      • state: AutocompleteRenderOptionState

        The state of the component.

      Returns ReactNode

Optional renderTags

renderTags?: ((value: Region[], getTagProps: AutocompleteRenderGetTagProps, ownerState: AutocompleteOwnerState<Region, false, false, false, "div">) => ReactNode)

Type declaration

    • (value: Region[], getTagProps: AutocompleteRenderGetTagProps, ownerState: AutocompleteOwnerState<Region, false, false, false, "div">): ReactNode

    • Render the selected value.

      Returns

      Parameters

      • value: Region[]

        The value provided to the component.

      • getTagProps: AutocompleteRenderGetTagProps

        A tag props getter.

      • ownerState: AutocompleteOwnerState<Region, false, false, false, "div">

        The state of the Autocomplete component.

      Returns ReactNode

Optional resource

resource?: string

Optional results

results?: number

Optional role

role?: AriaRole

Optional security

security?: string

Optional selectOnFocus

selectOnFocus?: boolean

If true, the input's text is selected on focus. It helps the user clear the selected value.

Default

!props.freeSolo

Optional size

size?: "medium" | "small"

The size of the component.

Default

'medium'

Optional slot

slot?: string

Optional slotProps

slotProps?: {
    clearIndicator?: Partial<IconButtonProps<"button", {}>>;
    paper?: PaperProps<"div", {}>;
    popper?: Partial<PopperProps>;
    popupIndicator?: Partial<IconButtonProps<"button", {}>>;
}

The props used for each slot inside.

Default

Type declaration

  • Optional clearIndicator?: Partial<IconButtonProps<"button", {}>>
  • Optional paper?: PaperProps<"div", {}>
  • Optional popper?: Partial<PopperProps>
  • Optional popupIndicator?: Partial<IconButtonProps<"button", {}>>

Optional spellCheck

spellCheck?: Booleanish

Optional style

style?: CSSProperties

Optional suppressContentEditableWarning

suppressContentEditableWarning?: boolean

Optional suppressHydrationWarning

suppressHydrationWarning?: boolean

Optional sx

sx?: SxProps<Theme>

The system prop that allows defining system overrides as well as additional CSS styles.

Optional tabIndex

tabIndex?: number

Optional title

title?: string

Optional translate

translate?: "yes" | "no"

Optional typeof

typeof?: string

Optional unselectable

unselectable?: "on" | "off"

Optional Internal unstable_classNamePrefix

unstable_classNamePrefix?: string

The prefix of the state class name, temporary for Joy UI

Default

'Mui'

Optional unstable_isActiveElementInListbox

unstable_isActiveElementInListbox?: ((listbox: RefObject<HTMLElement>) => boolean)

Type declaration

    • (listbox: RefObject<HTMLElement>): boolean
    • Internal

      Temporary for Joy UI because the parent listbox is the document object TODO v6: Normalize the logic and remove this param.

      Parameters

      • listbox: RefObject<HTMLElement>

      Returns boolean

Optional value

value?: null | Region

The value of the autocomplete.

The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop.

Optional vocab

vocab?: string

Settings

Member Visibility

Theme

Generated using TypeDoc