Skip to content

spatial-monorepo


spatial-monorepo / ui/src / SearchBarProps

Interface: SearchBarProps

Defined in: packages/ui/src/SearchBar.tsx:6

Properties

activeDescendantId?

optional activeDescendantId?: string

Defined in: packages/ui/src/SearchBar.tsx:16

id of the active descendant option element for aria-activedescendant.


expanded?

optional expanded?: boolean

Defined in: packages/ui/src/SearchBar.tsx:12

Controls aria-expanded (parent owns open/close state).


highlightedIndex?

optional highlightedIndex?: number

Defined in: packages/ui/src/SearchBar.tsx:14

Index of the currently highlighted suggestion (-1 = none).


index

index: WayfindingSearchIndex | null

Defined in: packages/ui/src/SearchBar.tsx:8

The MiniSearch index built by buildSearchIndex(). Null = no-op search.


loading?

optional loading?: boolean

Defined in: packages/ui/src/SearchBar.tsx:18

Whether a search is in-flight.


onArrowDown?

optional onArrowDown?: () => void

Defined in: packages/ui/src/SearchBar.tsx:22

Called when the user presses ArrowDown.

Returns

void


onArrowUp?

optional onArrowUp?: () => void

Defined in: packages/ui/src/SearchBar.tsx:24

Called when the user presses ArrowUp.

Returns

void


onClose?

optional onClose?: () => void

Defined in: packages/ui/src/SearchBar.tsx:20

Called when the user presses Escape.

Returns

void


onEnter?

optional onEnter?: () => void

Defined in: packages/ui/src/SearchBar.tsx:26

Called when the user presses Enter.

Returns

void


onResults

onResults: (results) => void

Defined in: packages/ui/src/SearchBar.tsx:10

Called with latest results after the debounce window.

Parameters

results

SearchIndexDocument[]

Returns

void

Released under commercial licensing.