Reference version

This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.

DockedSearchBar

一个用于显示内联搜索输入的 Jetpack Compose DockedSearchBar 组件。

Android
Included in Expo Go
Recommended version:
~56.0.16

Expo UI DockedSearchBar 与官方 Jetpack Compose SearchBar API 保持一致,并显示一个搜索输入框,该输入框会保持锚定在其父布局中,而不是扩展到全屏。

带有搜索图标和占位文本的 Material 3 停靠式搜索栏

安装

Terminal
npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

使用

基本停靠式搜索栏

BasicDockedSearchBarExample.tsx
import { useState } from 'react'; import { Host, DockedSearchBar } from '@expo/ui/jetpack-compose'; export default function BasicDockedSearchBarExample() { const [query, setQuery] = useState(''); return ( <Host matchContents> <DockedSearchBar onQueryChange={setQuery} /> </Host> ); }

使用占位符和前导图标

使用 DockedSearchBar.PlaceholderDockedSearchBar.LeadingIcon 插槽组件来自定义搜索栏外观。

DockedSearchBarWithSlotsExample.tsx
import { useState } from 'react'; import { Host, DockedSearchBar, Text } from '@expo/ui/jetpack-compose'; export default function DockedSearchBarWithSlotsExample() { const [query, setQuery] = useState(''); return ( <Host matchContents> <DockedSearchBar onQueryChange={setQuery}> <DockedSearchBar.Placeholder> <Text>搜索项目...</Text> </DockedSearchBar.Placeholder> <DockedSearchBar.LeadingIcon> <Text>🔍</Text> </DockedSearchBar.LeadingIcon> </DockedSearchBar> </Host> ); }

API

import { DockedSearchBar } from '@expo/ui/jetpack-compose';

Components

DockedSearchBar

Android

Type: React.Element<DockedSearchBarProps>

DockedSearchBarProps

children

Android
Optional • Type: React.ReactNode

The children of the component.

modifiers

Android
Optional • Type: ExpoModifier[]

Modifiers for the component.

onQueryChange

Android
Optional • Type: (query: string) => void

Callback function that is called when the search query changes.

DockedSearchBarLeadingIcon

Android

Type: React.Element<LeadingIconProps>

DockedSearchBarPlaceholder

Android

Type: React.Element<PlaceholderProps>