Interface SearchInputProps

The main search input component.

interface SearchInputProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string;
    advancedSearchDelimiter?: string;
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    appendTo?: HTMLElement | "inline" | (() => HTMLElement);
    areUtilitiesDisplayed?: boolean;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?:
        | "list"
        | "inline"
        | "none"
        | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?:
        | boolean
        | "step"
        | "time"
        | "location"
        | "true"
        | "false"
        | "page"
        | "date";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?:
        | "link"
        | "copy"
        | "move"
        | "none"
        | "execute"
        | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?:
        | boolean
        | "dialog"
        | "menu"
        | "grid"
        | "true"
        | "false"
        | "listbox"
        | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?:
        | boolean
        | "true"
        | "false"
        | "grammar"
        | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?:
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "all"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?:
        | "none"
        | "ascending"
        | "descending"
        | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    attributes?: string[] | SearchInputSearchAttribute[];
    autoCapitalize?:
        | string & {}
        | "none"
        | "off"
        | "on"
        | "sentences"
        | "words"
        | "characters";
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    color?: string;
    cols?: number;
    colSpan?: number;
    content?: string;
    contentEditable?: "inherit" | Booleanish | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    enterKeyHint?:
        | "search"
        | "enter"
        | "done"
        | "go"
        | "next"
        | "previous"
        | "send";
    expandableInput?: SearchInputExpandable;
    form?: string;
    formAction?: string;
    formAdditionalItems?: ReactNode;
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    hasWordsAttrLabel?: ReactNode;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    hint?: string;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inlist?: any;
    innerRef?: RefObject<any>;
    inputMode?:
        | "search"
        | "text"
        | "none"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal";
    integrity?: string;
    is?: string;
    isAdvancedSearchOpen?: boolean;
    isDisabled?: boolean;
    isNextNavigationButtonDisabled?: boolean;
    isPreviousNavigationButtonDisabled?: boolean;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    nextNavigationButtonAriaLabel?: string;
    nonce?: string;
    noValidate?: boolean;
    onAbort?: ReactEventHandler<HTMLDivElement>;
    onAbortCapture?: ReactEventHandler<HTMLDivElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLDivElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLDivElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>;
    onAnimationStart?: AnimationEventHandler<HTMLDivElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>;
    onAuxClick?: MouseEventHandler<HTMLDivElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLDivElement>;
    onBeforeInput?: FormEventHandler<HTMLDivElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLDivElement>;
    onBlur?: FocusEventHandler<HTMLDivElement>;
    onBlurCapture?: FocusEventHandler<HTMLDivElement>;
    onCanPlay?: ReactEventHandler<HTMLDivElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLDivElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLDivElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>;
    onChange?: ((event: FormEvent<HTMLInputElement>, value: string) => void);
    onChangeCapture?: FormEventHandler<HTMLDivElement>;
    onClear?: ((event: SyntheticEvent<HTMLButtonElement, Event>) => void);
    onClick?: MouseEventHandler<HTMLDivElement>;
    onClickCapture?: MouseEventHandler<HTMLDivElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLDivElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>;
    onCompositionStart?: CompositionEventHandler<HTMLDivElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>;
    onContextMenu?: MouseEventHandler<HTMLDivElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLDivElement>;
    onCopy?: ClipboardEventHandler<HTMLDivElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLDivElement>;
    onCut?: ClipboardEventHandler<HTMLDivElement>;
    onCutCapture?: ClipboardEventHandler<HTMLDivElement>;
    onDoubleClick?: MouseEventHandler<HTMLDivElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>;
    onDrag?: DragEventHandler<HTMLDivElement>;
    onDragCapture?: DragEventHandler<HTMLDivElement>;
    onDragEnd?: DragEventHandler<HTMLDivElement>;
    onDragEndCapture?: DragEventHandler<HTMLDivElement>;
    onDragEnter?: DragEventHandler<HTMLDivElement>;
    onDragEnterCapture?: DragEventHandler<HTMLDivElement>;
    onDragExit?: DragEventHandler<HTMLDivElement>;
    onDragExitCapture?: DragEventHandler<HTMLDivElement>;
    onDragLeave?: DragEventHandler<HTMLDivElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLDivElement>;
    onDragOver?: DragEventHandler<HTMLDivElement>;
    onDragOverCapture?: DragEventHandler<HTMLDivElement>;
    onDragStart?: DragEventHandler<HTMLDivElement>;
    onDragStartCapture?: DragEventHandler<HTMLDivElement>;
    onDrop?: DragEventHandler<HTMLDivElement>;
    onDropCapture?: DragEventHandler<HTMLDivElement>;
    onDurationChange?: ReactEventHandler<HTMLDivElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>;
    onEmptied?: ReactEventHandler<HTMLDivElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLDivElement>;
    onEncrypted?: ReactEventHandler<HTMLDivElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLDivElement>;
    onEnded?: ReactEventHandler<HTMLDivElement>;
    onEndedCapture?: ReactEventHandler<HTMLDivElement>;
    onError?: ReactEventHandler<HTMLDivElement>;
    onErrorCapture?: ReactEventHandler<HTMLDivElement>;
    onFocus?: FocusEventHandler<HTMLDivElement>;
    onFocusCapture?: FocusEventHandler<HTMLDivElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLDivElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
    onInput?: FormEventHandler<HTMLDivElement>;
    onInputCapture?: FormEventHandler<HTMLDivElement>;
    onInvalid?: FormEventHandler<HTMLDivElement>;
    onInvalidCapture?: FormEventHandler<HTMLDivElement>;
    onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>;
    onKeyPress?: KeyboardEventHandler<HTMLDivElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>;
    onKeyUp?: KeyboardEventHandler<HTMLDivElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>;
    onLoad?: ReactEventHandler<HTMLDivElement>;
    onLoadCapture?: ReactEventHandler<HTMLDivElement>;
    onLoadedData?: ReactEventHandler<HTMLDivElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>;
    onLoadStart?: ReactEventHandler<HTMLDivElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
    onMouseDown?: MouseEventHandler<HTMLDivElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseEnter?: MouseEventHandler<HTMLDivElement>;
    onMouseLeave?: MouseEventHandler<HTMLDivElement>;
    onMouseMove?: MouseEventHandler<HTMLDivElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseOut?: MouseEventHandler<HTMLDivElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseOver?: MouseEventHandler<HTMLDivElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseUp?: MouseEventHandler<HTMLDivElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>;
    onNextClick?: ((event: SyntheticEvent<HTMLButtonElement, Event>) => void);
    onPaste?: ClipboardEventHandler<HTMLDivElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>;
    onPause?: ReactEventHandler<HTMLDivElement>;
    onPauseCapture?: ReactEventHandler<HTMLDivElement>;
    onPlay?: ReactEventHandler<HTMLDivElement>;
    onPlayCapture?: ReactEventHandler<HTMLDivElement>;
    onPlaying?: ReactEventHandler<HTMLDivElement>;
    onPlayingCapture?: ReactEventHandler<HTMLDivElement>;
    onPointerCancel?: PointerEventHandler<HTMLDivElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerDown?: PointerEventHandler<HTMLDivElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerEnter?: PointerEventHandler<HTMLDivElement>;
    onPointerLeave?: PointerEventHandler<HTMLDivElement>;
    onPointerMove?: PointerEventHandler<HTMLDivElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerOut?: PointerEventHandler<HTMLDivElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerOver?: PointerEventHandler<HTMLDivElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerUp?: PointerEventHandler<HTMLDivElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>;
    onPreviousClick?: ((event: SyntheticEvent<HTMLButtonElement, Event>) => void);
    onProgress?: ReactEventHandler<HTMLDivElement>;
    onProgressCapture?: ReactEventHandler<HTMLDivElement>;
    onRateChange?: ReactEventHandler<HTMLDivElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>;
    onReset?: FormEventHandler<HTMLDivElement>;
    onResetCapture?: FormEventHandler<HTMLDivElement>;
    onResize?: ReactEventHandler<HTMLDivElement>;
    onResizeCapture?: ReactEventHandler<HTMLDivElement>;
    onScroll?: UIEventHandler<HTMLDivElement>;
    onScrollCapture?: UIEventHandler<HTMLDivElement>;
    onSearch?: ((event: SyntheticEvent<HTMLButtonElement, Event>, value: string, attrValueMap: {
        [key: string]: string;
    }) => void);
    onSeeked?: ReactEventHandler<HTMLDivElement>;
    onSeekedCapture?: ReactEventHandler<HTMLDivElement>;
    onSeeking?: ReactEventHandler<HTMLDivElement>;
    onSeekingCapture?: ReactEventHandler<HTMLDivElement>;
    onSelect?: ReactEventHandler<HTMLDivElement>;
    onSelectCapture?: ReactEventHandler<HTMLDivElement>;
    onStalled?: ReactEventHandler<HTMLDivElement>;
    onStalledCapture?: ReactEventHandler<HTMLDivElement>;
    onSubmit?: FormEventHandler<HTMLDivElement>;
    onSubmitCapture?: FormEventHandler<HTMLDivElement>;
    onSuspend?: ReactEventHandler<HTMLDivElement>;
    onSuspendCapture?: ReactEventHandler<HTMLDivElement>;
    onTimeUpdate?: ReactEventHandler<HTMLDivElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>;
    onToggleAdvancedSearch?: ((event: SyntheticEvent<HTMLButtonElement, Event>, isOpen?: boolean) => void);
    onTouchCancel?: TouchEventHandler<HTMLDivElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>;
    onTouchEnd?: TouchEventHandler<HTMLDivElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>;
    onTouchMove?: TouchEventHandler<HTMLDivElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>;
    onTouchStart?: TouchEventHandler<HTMLDivElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>;
    onVolumeChange?: ReactEventHandler<HTMLDivElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>;
    onWaiting?: ReactEventHandler<HTMLDivElement>;
    onWaitingCapture?: ReactEventHandler<HTMLDivElement>;
    onWheel?: WheelEventHandler<HTMLDivElement>;
    onWheelCapture?: WheelEventHandler<HTMLDivElement>;
    open?: boolean;
    openMenuButtonAriaLabel?: string;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    previousNavigationButtonAriaLabel?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    rel?: string;
    required?: boolean;
    resetButtonLabel?: string;
    resource?: string;
    resultsCount?: string | number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rows?: number;
    rowSpan?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    searchInputId?: string;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    submitSearchButtonLabel?: string;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "off" | "on";
    useMap?: string;
    value?: string;
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
    zIndex?: number;
}

Hierarchy

Omit<React.HTMLProps<HTMLDivElement>, "onChange" | "results" | "ref">
- SearchInputProps

Index

Properties

about? accept? acceptCharset? accessKey? action? advancedSearchDelimiter? allowFullScreen? allowTransparency? alt? appendTo? areUtilitiesDisplayed? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? 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-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? as? async? attributes? autoCapitalize? autoComplete? autoCorrect? autoFocus? autoPlay? autoSave? capture? cellPadding? cellSpacing? challenge? charSet? checked? children? cite? classID? className? color? cols? colSpan? content? contentEditable? contextMenu? controls? coords? crossOrigin? dangerouslySetInnerHTML? data? datatype? dateTime? default? defaultChecked? defaultValue? defer? dir? disabled? download? draggable? encType? enterKeyHint? expandableInput? form? formAction? formAdditionalItems? formEncType? formMethod? formNoValidate? formTarget? frameBorder? hasWordsAttrLabel? headers? height? hidden? high? hint? href? hrefLang? htmlFor? httpEquiv? id? inlist? innerRef? inputMode? integrity? is? isAdvancedSearchOpen? isDisabled? isNextNavigationButtonDisabled? isPreviousNavigationButtonDisabled? itemID? itemProp? itemRef? itemScope? itemType? key? keyParams? keyType? kind? label? lang? list? loop? low? manifest? marginHeight? marginWidth? max? maxLength? media? mediaGroup? method? min? minLength? multiple? muted? name? nextNavigationButtonAriaLabel? nonce? noValidate? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClear? onClick? onClickCapture? 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? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onNextClick? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onPreviousClick? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSearch? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onToggleAdvancedSearch? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionEnd? onTransitionEndCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? open? openMenuButtonAriaLabel? optimum? pattern? placeholder? playsInline? poster? prefix? preload? previousNavigationButtonAriaLabel? property? radioGroup? readOnly? rel? required? resetButtonLabel? resource? resultsCount? rev? reversed? role? rows? rowSpan? sandbox? scope? scoped? scrolling? seamless? searchInputId? security? selected? shape? size? sizes? slot? span? spellCheck? src? srcDoc? srcLang? srcSet? start? step? style? submitSearchButtonLabel? summary? suppressContentEditableWarning? suppressHydrationWarning? tabIndex? target? title? translate? type? typeof? unselectable? useMap? value? vocab? width? wmode? wrap? zIndex?

Properties

`Optional`about

about?: string

`Optional`accept

accept?: string

`Optional`acceptCharset

acceptCharset?: string

`Optional`accessKey

accessKey?: string

`Optional`action

action?: string

`Optional`advancedSearchDelimiter

advancedSearchDelimiter?: string

Delimiter in the query string for pairing attributes with search values. Required whenever attributes are passed as props.

`Optional`allowFullScreen

allowFullScreen?: boolean

`Optional`allowTransparency

allowTransparency?: boolean

`Optional`alt

alt?: string

`Optional`appendTo

appendTo?: HTMLElement | "inline" | (() => HTMLElement)

The container to append the menu to. If your menu is being cut off you can append it to an element higher up the DOM tree. Some examples: appendTo={() => document.body} appendTo={document.getElementById('target')}

`Optional`areUtilitiesDisplayed

areUtilitiesDisplayed?: boolean

Flag to indicate utilities should be displayed. By default if this prop is undefined or false, utilities will only be displayed when the search input has a value.

`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"
    | "inline"
    | "none"
    | "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-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

`Optional`aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

`Optional`aria-busy

aria-busy?: Booleanish

`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-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

`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

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-description

aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

`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

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

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

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

An accessible label for the search input.

`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

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-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

`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`as

as?: string

`Optional`async

async?: boolean

`Optional`attributes

attributes?: string[] | SearchInputSearchAttribute[]

Array of attribute values used for dynamically generated advanced search.

`Optional`autoCapitalize

autoCapitalize?:
    | string & {}
    | "none"
    | "off"
    | "on"
    | "sentences"
    | "words"
    | "characters"

`Optional`autoComplete

autoComplete?: string

`Optional`autoCorrect

autoCorrect?: string

`Optional`autoFocus

autoFocus?: boolean

`Optional`autoPlay

autoPlay?: boolean

`Optional`autoSave

autoSave?: string

`Optional`capture

capture?: boolean | "user" | "environment"

`Optional`cellPadding

cellPadding?: string | number

`Optional`cellSpacing

cellSpacing?: string | number

`Optional`challenge

challenge?: string

`Optional`charSet

charSet?: string

`Optional`checked

checked?: boolean

`Optional`children

children?: ReactNode

`Optional`cite

cite?: string

`Optional`classID

classID?: string

`Optional`className

className?: string

Additional classes added to the search input.

`Optional`color

color?: string

`Optional`cols

cols?: number

`Optional`colSpan

colSpan?: number

`Optional`content

content?: string

`Optional`contentEditable

contentEditable?: "inherit" | Booleanish | "plaintext-only"

`Optional`contextMenu

contextMenu?: string

`Optional`controls

controls?: boolean

`Optional`coords

coords?: string

`Optional`crossOrigin

crossOrigin?: CrossOrigin

`Optional`dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
__html: string | TrustedHTML;
}

`Optional`data

data?: string

`Optional`datatype

datatype?: string

`Optional`dateTime

dateTime?: string

`Optional`default

default?: boolean

`Optional`defaultChecked

defaultChecked?: boolean

`Optional`defaultValue

defaultValue?: string | number | readonly string[]

`Optional`defer

defer?: boolean

`Optional`dir

dir?: string

`Optional`disabled

disabled?: boolean

`Optional`download

download?: any

`Optional`draggable

draggable?: Booleanish

`Optional`encType

encType?: string

`Optional`enterKeyHint

`Optional`expandableInput

expandableInput?: SearchInputExpandable

Object that makes the search input expandable/collapsible.

`Optional`form

form?: string

`Optional`formAction

formAction?: string

`Optional`formAdditionalItems

formAdditionalItems?: ReactNode

`Optional`formEncType

formEncType?: string

`Optional`formMethod

formMethod?: string

`Optional`formNoValidate

formNoValidate?: boolean

`Optional`formTarget

formTarget?: string

`Optional`frameBorder

frameBorder?: string | number

`Optional`hasWordsAttrLabel

hasWordsAttrLabel?: ReactNode

Attribute label for strings unassociated with one of the provided listed attributes.

`Optional`headers

headers?: string

`Optional`height

height?: string | number

`Optional`hidden

hidden?: boolean

`Optional`high

high?: number

`Optional`hint

hint?: string

A suggestion for autocompleting.

`Optional`href

href?: string

`Optional`hrefLang

hrefLang?: string

`Optional`htmlFor

htmlFor?: string

`Optional`httpEquiv

httpEquiv?: string

`Optional`id

id?: string

`Optional`inlist

inlist?: any

`Optional`innerRef

innerRef?: RefObject<any>

Hide

A reference object to attach to the input box.

`Optional`inputMode

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`integrity

integrity?: string

`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`isAdvancedSearchOpen

isAdvancedSearchOpen?: boolean

A flag for controlling the open state of a custom advanced search implementation.

`Optional`isDisabled

isDisabled?: boolean

Flag indicating if search input is disabled.

`Optional`isNextNavigationButtonDisabled

isNextNavigationButtonDisabled?: boolean

Flag indicating if the next navigation button is disabled.

`Optional`isPreviousNavigationButtonDisabled

isPreviousNavigationButtonDisabled?: boolean

Flag indicating if the previous navigation button is disabled.

`Optional`itemID

itemID?: string

`Optional`itemProp

itemProp?: string

`Optional`itemRef

itemRef?: string

`Optional`itemScope

itemScope?: boolean

`Optional`itemType

itemType?: string

`Optional`key

key?: Key

`Optional`keyParams

keyParams?: string

`Optional`keyType

keyType?: string

`Optional`kind

kind?: string

`Optional`label

label?: string

`Optional`lang

lang?: string

`Optional`list

list?: string

`Optional`loop

loop?: boolean

`Optional`low

low?: number

`Optional`manifest

manifest?: string

`Optional`marginHeight

marginHeight?: number

`Optional`marginWidth

marginWidth?: number

`Optional`max

max?: string | number

`Optional`maxLength

maxLength?: number

`Optional`media

media?: string

`Optional`mediaGroup

mediaGroup?: string

`Optional`method

method?: string

`Optional`min

min?: string | number

`Optional`minLength

minLength?: number

`Optional`multiple

multiple?: boolean

`Optional`muted

muted?: boolean

`Optional`name

name?: string

Name attribue for the search input

`Optional`nextNavigationButtonAriaLabel

nextNavigationButtonAriaLabel?: string

Accessible label for the button to navigate to next result.

`Optional`nonce

nonce?: string

`Optional`noValidate

noValidate?: boolean

`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: FormEvent<HTMLInputElement>, value: string) => void)

A callback for when the input value changes.

`Optional`onChangeCapture

onChangeCapture?: FormEventHandler<HTMLDivElement>

`Optional`onClear

onClear?: ((event: SyntheticEvent<HTMLButtonElement, Event>) => void)

A callback for when the user clicks the clear button.

`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

Use onKeyUp or onKeyDown instead

`Optional`onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>

Deprecated

Use onKeyUpCapture or onKeyDownCapture instead

`Optional`onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLDivElement>

`Optional`onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>

`Optional`onLoad

onLoad?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedData

onLoadedData?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadStart

onLoadStart?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadStartCapture

onLoadStartCapture?: 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`onNextClick

onNextClick?: ((event: SyntheticEvent<HTMLButtonElement, Event>) => void)

A callback for when the user clicks to navigate to next result.

`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`onPointerLeave

onPointerLeave?: 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`onPreviousClick

onPreviousClick?: ((event: SyntheticEvent<HTMLButtonElement, Event>) => void)

A callback for when the user clicks to navigate to previous result.

`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`onSearch

onSearch?: ((event: SyntheticEvent<HTMLButtonElement, Event>, value: string, attrValueMap: {
[key: string]: string;
}) => void)

A callback for when the search button is clicked.

`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`onToggleAdvancedSearch

onToggleAdvancedSearch?: ((event: SyntheticEvent<HTMLButtonElement, Event>, isOpen?: boolean) => void)

A callback for when the open advanced search button is clicked.

`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

`Optional`openMenuButtonAriaLabel

openMenuButtonAriaLabel?: string

Accessible label for the button which opens the advanced search form menu.

`Optional`optimum

optimum?: number

`Optional`pattern

pattern?: string

`Optional`placeholder

placeholder?: string

Placeholder text of the search input.

`Optional`playsInline

playsInline?: boolean

`Optional`poster

poster?: string

`Optional`prefix

prefix?: string

`Optional`preload

preload?: string

`Optional`previousNavigationButtonAriaLabel

previousNavigationButtonAriaLabel?: string

Accessible label for the button to navigate to previous result.

`Optional`property

property?: string

`Optional`radioGroup

radioGroup?: string

`Optional`readOnly

readOnly?: boolean

`Optional`rel

rel?: string

`Optional`required

required?: boolean

`Optional`resetButtonLabel

resetButtonLabel?: string

Label for the button which resets the advanced search form and clears the search input.

`Optional`resource

resource?: string

`Optional`resultsCount

resultsCount?: string | number

The number of search results returned. Either a total number of results, or a string representing the current result over the total number of results. i.e. "1 / 5".

`Optional`rev

rev?: string

`Optional`reversed

reversed?: boolean

`Optional`role

role?: AriaRole

`Optional`rows

rows?: number

`Optional`rowSpan

rowSpan?: number

`Optional`sandbox

sandbox?: string

`Optional`scope

scope?: string

`Optional`scoped

scoped?: boolean

`Optional`scrolling

scrolling?: string

`Optional`seamless

seamless?: boolean

`Optional`searchInputId

searchInputId?: string

Id for the search input

`Optional`security

security?: string

`Optional`selected

selected?: boolean

`Optional`shape

shape?: string

`Optional`size

size?: number

`Optional`sizes

sizes?: string

`Optional`slot

slot?: string

`Optional`span

span?: number

`Optional`spellCheck

spellCheck?: Booleanish

`Optional`src

src?: string

`Optional`srcDoc

srcDoc?: string

`Optional`srcLang

srcLang?: string

`Optional`srcSet

srcSet?: string

`Optional`start

start?: number

`Optional`step

step?: string | number

`Optional`style

style?: CSSProperties

`Optional`submitSearchButtonLabel

submitSearchButtonLabel?: string

Label for the button which calls the onSearch event handler.

`Optional`summary

summary?: string

`Optional`suppressContentEditableWarning

suppressContentEditableWarning?: boolean

`Optional`suppressHydrationWarning

suppressHydrationWarning?: boolean

`Optional`tabIndex

tabIndex?: number

`Optional`target

target?: string

`Optional`title

title?: string

`Optional`translate

translate?: "yes" | "no"

`Optional`type

type?: string

`Optional`typeof

typeof?: string

`Optional`unselectable

unselectable?: "off" | "on"

`Optional`useMap

useMap?: string

`Optional`value

value?: string

Value of the search input.

`Optional`vocab

vocab?: string

`Optional`width

width?: string | number

`Optional`wmode

wmode?: string

`Optional`wrap

wrap?: string

`Optional`zIndex

zIndex?: number

z-index of the advanced search form when appendTo is not inline.

Interface SearchInputProps

Hierarchy

Index

Properties

Properties

Optionalabout

Optionalaccept

OptionalacceptCharset

OptionalaccessKey

Optionalaction

OptionaladvancedSearchDelimiter

OptionalallowFullScreen

OptionalallowTransparency

Optionalalt

OptionalappendTo

OptionalareUtilitiesDisplayed

Optionalaria-activedescendant

Optionalaria-atomic

Optionalaria-autocomplete

Optionalaria-braillelabel

See

Optionalaria-brailleroledescription

See

Optionalaria-busy

Optionalaria-checked

See

Optionalaria-colcount

See

Optionalaria-colindex

See

Optionalaria-colindextext

See

Optionalaria-colspan

See

Optionalaria-controls

See

Optionalaria-current

Optionalaria-describedby

See

Optionalaria-description

See

Optionalaria-details

See

Optionalaria-disabled

See

Optionalaria-dropeffect

Deprecated

Optionalaria-errormessage

See

Optionalaria-expanded

Optionalaria-flowto

Optionalaria-grabbed

Deprecated

Optionalaria-haspopup

Optionalaria-hidden

See

Optionalaria-invalid

See

Optionalaria-keyshortcuts

Optionalaria-label

Optionalaria-labelledby

See

Optionalaria-level

Optionalaria-live

Optionalaria-modal

Optionalaria-multiline

Optionalaria-multiselectable

Optionalaria-orientation

Optionalaria-owns

See

Optionalaria-placeholder

Optionalaria-posinset

See

Optionalaria-pressed

See

Optionalaria-readonly

See

Optionalaria-relevant

See

Optionalaria-required

`Optional`about

`Optional`accept

`Optional`acceptCharset

`Optional`accessKey

`Optional`action

`Optional`advancedSearchDelimiter

`Optional`allowFullScreen

`Optional`allowTransparency

`Optional`alt

`Optional`appendTo

`Optional`areUtilitiesDisplayed

`Optional`aria-activedescendant

`Optional`aria-atomic

`Optional`aria-autocomplete

`Optional`aria-braillelabel

`Optional`aria-brailleroledescription

`Optional`aria-busy

`Optional`aria-checked

`Optional`aria-colcount

`Optional`aria-colindex

`Optional`aria-colindextext

`Optional`aria-colspan

`Optional`aria-controls

`Optional`aria-current

`Optional`aria-describedby

`Optional`aria-description

`Optional`aria-details

`Optional`aria-disabled

`Optional`aria-dropeffect

`Optional`aria-errormessage

`Optional`aria-expanded

`Optional`aria-flowto

`Optional`aria-grabbed

`Optional`aria-haspopup

`Optional`aria-hidden

`Optional`aria-invalid

`Optional`aria-keyshortcuts

`Optional`aria-label

`Optional`aria-labelledby

`Optional`aria-level

`Optional`aria-live

`Optional`aria-modal

`Optional`aria-multiline

`Optional`aria-multiselectable

`Optional`aria-orientation

`Optional`aria-owns

`Optional`aria-placeholder

`Optional`aria-posinset

`Optional`aria-pressed

`Optional`aria-readonly

`Optional`aria-relevant

`Optional`aria-required

`Optional`aria-roledescription

`Optional`aria-rowcount

`Optional`aria-rowindex

`Optional`aria-rowindextext

`Optional`aria-rowspan

`Optional`aria-selected

`Optional`aria-setsize

`Optional`aria-sort

`Optional`aria-valuemax

`Optional`aria-valuemin

`Optional`aria-valuenow

`Optional`aria-valuetext

`Optional`as

`Optional`async

`Optional`attributes

`Optional`autoCapitalize

`Optional`autoComplete

`Optional`autoCorrect

`Optional`autoFocus

`Optional`autoPlay

`Optional`autoSave

`Optional`capture

`Optional`cellPadding

`Optional`cellSpacing

`Optional`challenge

`Optional`charSet

`Optional`checked

`Optional`children