‹ Search

Types

Types

The types of search.

SectionSearchDraftDocumented, not reviewed yet: the API can change.

SearchChangedEvent

Type

type SearchChangedEvent = NavigationEvents['searchChanged']

Member	Type	Description
textRequired	string	The text in the field.
isFocusedRequired	boolean	Whether the field has the focus.
scope	string	The id of the selected scope filter. Set only when the field has a scope bar.
tokens	string[]	The ids of the tokens in the field. Set only when the field uses tokens. iOSiPadOSAndroid (not supported)
screenRequired	ScreenRef

Defined in src/api/events/navigationEvents.ts ↗

SearchSubmittedEvent

Type

type SearchSubmittedEvent = NavigationEvents['searchSubmitted']

Member	Type	Description
textRequired	string	The text in the field.
scope	string	The id of the selected scope filter. Set only when the field has a scope bar.
tokens	string[]	The ids of the tokens in the field. Set only when the field uses tokens. iOSiPadOSAndroid (not supported)
screenRequired	ScreenRef

Defined in src/api/events/navigationEvents.ts ↗

SearchCancelledEvent

Type

type SearchCancelledEvent = NavigationEvents['searchCancelled']

Member	Type	Description
screenRequired	ScreenRef

Defined in src/api/events/navigationEvents.ts ↗

SearchSuggestionPickedEvent

Type

type SearchSuggestionPickedEvent = NavigationEvents['searchSuggestionPicked']

Member	Type	Description
suggestionIdRequired	string	The id of the suggestion that was picked.
screenRequired	ScreenRef

Defined in src/api/events/navigationEvents.ts ↗