Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
FormsReact Native

Search field

Filter native content with a density-aware search field and clear action.

Public APILumenSearchFieldReact Native

Native example

Use Search field

Use for filtering an existing collection. Keep search results and empty states close to the field so focus changes remain understandable.

View verified React Native runtime capture
Search field rendered in the Expo web renderer Lumen playground
Verified runtime captureExpo web renderer
tsx
<LumenSearchField
  value={query}
  onChangeText={setQuery}
  prompt="Search workspaces"
/>

Reference

Public API

The primary shared and platform-specific options exposed by LumenSearchField.

APIValues or typeDefaultDescription
promptStringSearchProvides placeholder and field context.
valuestringRequiredStores the current search query.
onChangeText(String) -> UnitRequiredUpdates the controlled query.
editableBooleantrueControls native disabled presentation.
clearLabelStringClear searchNames the clear action.

Native behavior

Design and accessibility

When to use it

Use for filtering an existing collection. Keep search results and empty states close to the field so focus changes remain understandable.

Accessibility

The field uses native text input and provides a labeled clear button whenever text is present.

Shared component

Available on other platforms

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives