KanbanSearchProps

Extends

• SearchFieldProps

Properties

aria-activedescendant?

optional aria-activedescendant: string

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

Inherited from

SearchFieldProps.aria-activedescendant

---

aria-autocomplete?

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

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

Inherited from

SearchFieldProps.aria-autocomplete

---

aria-controls?

optional aria-controls: string

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

Inherited from

SearchFieldProps.aria-controls

---

aria-describedby?

optional aria-describedby: string

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

Inherited from

SearchFieldProps.aria-describedby

---

aria-details?

optional aria-details: string

Identifies the element (or elements) that provide a detailed, extended description for the object.

Inherited from

SearchFieldProps.aria-details

---

aria-errormessage?

optional aria-errormessage: string

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

Inherited from

SearchFieldProps.aria-errormessage

---

aria-haspopup?

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

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

Inherited from

SearchFieldProps.aria-haspopup

---

aria-label?

optional aria-label: string

Defines a string value that labels the current element.

Inherited from

SearchFieldProps.aria-label

---

aria-labelledby?

optional aria-labelledby: string

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

Inherited from

SearchFieldProps.aria-labelledby

---

autoComplete?

optional autoComplete: string

Describes the type of autocomplete functionality the input should provide if any. See MDN.

Inherited from

SearchFieldProps.autoComplete

---

autoCorrect?

optional autoCorrect: string

An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See MDN.

Inherited from

SearchFieldProps.autoCorrect

---

autoFocus?

optional autoFocus: boolean

Whether the element should receive focus on render.

Inherited from

SearchFieldProps.autoFocus

---

children?

optional children: ChildrenOrFunction<SearchFieldRenderProps>

The children of the component. A function may be provided to alter the children based on component state.

Inherited from

SearchFieldProps.children

---

classNames?

optional classNames: object

clear?

optional clear: ClassNameOrFunction<ButtonRenderProps>

field?

optional field: ClassNameOrFunction<SearchFieldRenderProps>

input?

optional input: ClassNameOrFunction<InputRenderProps>

loading?

optional loading: string

search?

optional search: string

Inherited from

SearchFieldProps.classNames

---

defaultValue?

optional defaultValue: string

The default value (uncontrolled).

Inherited from

SearchFieldProps.defaultValue

---

dir?

optional dir: string

Inherited from

SearchFieldProps.dir

---

enterKeyHint?

optional enterKeyHint: "search" | "enter" | "done" | "go" | "next" | "previous" | "send"

An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See MDN.

Inherited from

SearchFieldProps.enterKeyHint

---

excludeFromTabOrder?

optional excludeFromTabOrder: boolean

Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.

Inherited from

SearchFieldProps.excludeFromTabOrder

---

form?

optional form: string

The <form> element to associate the input with. The value of this attribute must be the id of a <form> in the same document. See MDN.

Inherited from

SearchFieldProps.form

---

hidden?

optional hidden: boolean

Inherited from

SearchFieldProps.hidden

---

id?

optional id: string

The element's unique identifier. See MDN.

Inherited from

SearchFieldProps.id

---

inert?

optional inert: boolean

Inherited from

SearchFieldProps.inert

---

inputMode?

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

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

Inherited from

SearchFieldProps.inputMode

---

inputProps?

optional inputProps: Omit<InputProps, "type">

Inherited from

SearchFieldProps.inputProps

---

isDisabled?

optional isDisabled: boolean

Whether the input is disabled.

Inherited from

SearchFieldProps.isDisabled

---

isInvalid?

optional isInvalid: boolean

Whether the input value is invalid.

Inherited from

SearchFieldProps.isInvalid

---

isLoading?

optional isLoading: boolean

Displays a loading spinner.

Inherited from

SearchFieldProps.isLoading

---

isReadOnly?

optional isReadOnly: boolean

Whether the input can be selected but not changed by the user.

Inherited from

SearchFieldProps.isReadOnly

---

isRequired?

optional isRequired: boolean

Whether user input is required on the input before form submission.

Inherited from

SearchFieldProps.isRequired

---

key?

optional key: Key | null

Inherited from

SearchFieldProps.key

---

lang?

optional lang: string

Inherited from

SearchFieldProps.lang

---

maxLength?

optional maxLength: number

The maximum number of characters supported by the input. See MDN.

Inherited from

SearchFieldProps.maxLength

---

minLength?

optional minLength: number

The minimum number of characters required by the input. See MDN.

Inherited from

SearchFieldProps.minLength

---

name?

optional name: string

The name of the input element, used when submitting an HTML form. See MDN.

Inherited from

SearchFieldProps.name

---

onAnimationEnd?

optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAnimationEnd

---

onAnimationEndCapture?

optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAnimationEndCapture

---

onAnimationIteration?

optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAnimationIteration

---

onAnimationIterationCapture?

optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAnimationIterationCapture

---

onAnimationStart?

optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAnimationStart

---

onAnimationStartCapture?

optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAnimationStartCapture

---

onAuxClick?

optional onAuxClick: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAuxClick

---

onAuxClickCapture?

optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onAuxClickCapture

---

onBeforeInput?

optional onBeforeInput: FormEventHandler<HTMLInputElement>

Handler that is called when the input value is about to be modified. See MDN.

Inherited from

SearchFieldProps.onBeforeInput

---

onBlur()?

optional onBlur: (e) => void

Handler that is called when the element loses focus.

Parameters

e

FocusEvent<HTMLInputElement>

Returns

void

Inherited from

SearchFieldProps.onBlur

---

onChange()?

optional onChange: (value) => void

Handler that is called when the value changes.

Parameters

value

string

Returns

void

Inherited from

SearchFieldProps.onChange

---

onClear()?

optional onClear: () => void

Handler that is called when the clear button is pressed.

Returns

void

Inherited from

SearchFieldProps.onClear

---

onClick?

optional onClick: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onClick

---

onClickCapture?

optional onClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onClickCapture

---

onCompositionEnd?

optional onCompositionEnd: CompositionEventHandler<HTMLInputElement>

Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.

Inherited from

SearchFieldProps.onCompositionEnd

---

onCompositionStart?

optional onCompositionStart: CompositionEventHandler<HTMLInputElement>

Handler that is called when a text composition system starts a new text composition session. See MDN.

Inherited from

SearchFieldProps.onCompositionStart

---

onCompositionUpdate?

optional onCompositionUpdate: CompositionEventHandler<HTMLInputElement>

Handler that is called when a new character is received in the current text composition session. See MDN.

Inherited from

SearchFieldProps.onCompositionUpdate

---

onContextMenu?

optional onContextMenu: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onContextMenu

---

onContextMenuCapture?

optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onContextMenuCapture

---

onCopy?

optional onCopy: ClipboardEventHandler<HTMLInputElement>

Handler that is called when the user copies text. See MDN.

Inherited from

SearchFieldProps.onCopy

---

onCut?

optional onCut: ClipboardEventHandler<HTMLInputElement>

Handler that is called when the user cuts text. See MDN.

Inherited from

SearchFieldProps.onCut

---

onDoubleClick?

optional onDoubleClick: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onDoubleClick

---

onDoubleClickCapture?

optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onDoubleClickCapture

---

onFocus()?

optional onFocus: (e) => void

Handler that is called when the element receives focus.

Parameters

e

FocusEvent<HTMLInputElement>

Returns

void

Inherited from

SearchFieldProps.onFocus

---

onFocusChange()?

optional onFocusChange: (isFocused) => void

Handler that is called when the element's focus status changes.

Parameters

isFocused

boolean

Returns

void

Inherited from

SearchFieldProps.onFocusChange

---

onGotPointerCapture?

optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onGotPointerCapture

---

onGotPointerCaptureCapture?

optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onGotPointerCaptureCapture

---

onInput()?

optional onInput: (e) => void

Handler that is called when the input value is modified. See MDN.

Parameters

e

FormEvent<HTMLInputElement>

Returns

void

Overrides

SearchFieldProps.onInput

---

onKeyDown()?

optional onKeyDown: (e) => void

Handler that is called when a key is pressed.

Parameters

e

KeyboardEvent

Returns

void

Inherited from

SearchFieldProps.onKeyDown

---

onKeyUp()?

optional onKeyUp: (e) => void

Handler that is called when a key is released.

Parameters

e

KeyboardEvent

Returns

void

Inherited from

SearchFieldProps.onKeyUp

---

onLostPointerCapture?

optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onLostPointerCapture

---

onLostPointerCaptureCapture?

optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onLostPointerCaptureCapture

---

onMouseDown?

optional onMouseDown: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseDown

---

onMouseDownCapture?

optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseDownCapture

---

onMouseEnter?

optional onMouseEnter: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseEnter

---

onMouseLeave?

optional onMouseLeave: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseLeave

---

onMouseMove?

optional onMouseMove: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseMove

---

onMouseMoveCapture?

optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseMoveCapture

---

onMouseOut?

optional onMouseOut: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseOut

---

onMouseOutCapture?

optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseOutCapture

---

onMouseOver?

optional onMouseOver: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseOver

---

onMouseOverCapture?

optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseOverCapture

---

onMouseUp?

optional onMouseUp: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseUp

---

onMouseUpCapture?

optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onMouseUpCapture

---

onPaste?

optional onPaste: ClipboardEventHandler<HTMLInputElement>

Handler that is called when the user pastes text. See MDN.

Inherited from

SearchFieldProps.onPaste

---

onPointerCancel?

optional onPointerCancel: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerCancel

---

onPointerCancelCapture?

optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerCancelCapture

---

onPointerDown?

optional onPointerDown: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerDown

---

onPointerDownCapture?

optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerDownCapture

---

onPointerEnter?

optional onPointerEnter: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerEnter

---

onPointerLeave?

optional onPointerLeave: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerLeave

---

onPointerMove?

optional onPointerMove: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerMove

---

onPointerMoveCapture?

optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerMoveCapture

---

onPointerOut?

optional onPointerOut: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerOut

---

onPointerOutCapture?

optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerOutCapture

---

onPointerOver?

optional onPointerOver: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerOver

---

onPointerOverCapture?

optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerOverCapture

---

onPointerUp?

optional onPointerUp: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerUp

---

onPointerUpCapture?

optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onPointerUpCapture

---

onScroll?

optional onScroll: UIEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onScroll

---

onScrollCapture?

optional onScrollCapture: UIEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onScrollCapture

---

onSelect?

optional onSelect: ReactEventHandler<HTMLInputElement>

Handler that is called when text in the input is selected. See MDN.

Inherited from

SearchFieldProps.onSelect

---

onSubmit()?

optional onSubmit: (value) => void

Handler that is called when the SearchField is submitted.

Parameters

value

string

Returns

void

Inherited from

SearchFieldProps.onSubmit

---

onTouchCancel?

optional onTouchCancel: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchCancel

---

onTouchCancelCapture?

optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchCancelCapture

---

onTouchEnd?

optional onTouchEnd: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchEnd

---

onTouchEndCapture?

optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchEndCapture

---

onTouchMove?

optional onTouchMove: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchMove

---

onTouchMoveCapture?

optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchMoveCapture

---

onTouchStart?

optional onTouchStart: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchStart

---

onTouchStartCapture?

optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTouchStartCapture

---

onTransitionCancel?

optional onTransitionCancel: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionCancel

---

onTransitionCancelCapture?

optional onTransitionCancelCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionCancelCapture

---

onTransitionEnd?

optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionEnd

---

onTransitionEndCapture?

optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionEndCapture

---

onTransitionRun?

optional onTransitionRun: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionRun

---

onTransitionRunCapture?

optional onTransitionRunCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionRunCapture

---

onTransitionStart?

optional onTransitionStart: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionStart

---

onTransitionStartCapture?

optional onTransitionStartCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onTransitionStartCapture

---

onWheel?

optional onWheel: WheelEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onWheel

---

onWheelCapture?

optional onWheelCapture: WheelEventHandler<HTMLDivElement>

Inherited from

SearchFieldProps.onWheelCapture

---

ref?

optional ref: Ref<HTMLDivElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

See

React Docs

Inherited from

SearchFieldProps.ref

---

slot?

optional slot: string | null

A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

Inherited from

SearchFieldProps.slot

---

spellCheck?

optional spellCheck: string

An enumerated attribute that defines whether the element may be checked for spelling errors. See MDN.

Inherited from

SearchFieldProps.spellCheck

---

style?

optional style: StyleOrFunction<SearchFieldRenderProps>

The inline style for the element. A function may be provided to compute the style based on component state.

Inherited from

SearchFieldProps.style

---

translate?

optional translate: "yes" | "no"

Inherited from

SearchFieldProps.translate

---

validate()?

optional validate: (value) => true | ValidationError | null | undefined

A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead.

Parameters

value

string

Returns

true | ValidationError | null | undefined

Inherited from

SearchFieldProps.validate

---

validationBehavior?

optional validationBehavior: "native" | "aria"

Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.

Default

'native'

Inherited from

SearchFieldProps.validationBehavior

---

value?

optional value: string

The current value (controlled).

Inherited from

SearchFieldProps.value

---

variant?

optional variant: "filled" | "outlined"

Inherited from

KanbanSearchProps.variant