SearchBar

用于搜索输入功能的 Jetpack Compose SearchBar 组件。

Android

Included in Expo Go

GitHub

npm

更新日志

Recommended version:

~58.0.1

Expo UI SearchBar 与官方 Jetpack Compose Search API 相匹配，并提供支持占位文本和全屏展开搜索的搜索输入框。

安装

Terminal

- npx expo install @expo/ui

- yarn expo install @expo/ui

- pnpm expo install @expo/ui

- bun expo install @expo/ui

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

用法

基本搜索栏

BasicSearchBarExample.tsx

import { useState } from 'react';
import { Host, SearchBar } from '@expo/ui/jetpack-compose';

export default function BasicSearchBarExample() {
  const [query, setQuery] = useState('');

  return (
    <Host matchContents>
      <SearchBar onSearch={searchText => setQuery(searchText)} />
    </Host>
  );
}

带占位文本的搜索栏

使用 SearchBar.Placeholder 子组件，在搜索框为空时显示提示文本。

SearchBarPlaceholderExample.tsx

import { useState } from 'react';
import { Host, SearchBar, Text } from '@expo/ui/jetpack-compose';

export default function SearchBarPlaceholderExample() {
  const [query, setQuery] = useState('');

  return (
    <Host matchContents>
      <SearchBar onSearch={searchText => setQuery(searchText)}>
        <SearchBar.Placeholder>
          <Text>Search items...</Text>
        </SearchBar.Placeholder>
      </SearchBar>
    </Host>
  );
}

API

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

Components

`ExpandedFullScreenSearchBar`

Android

Type: React.Element<ExpandedFullScreenSearchBarProps>

ExpandedFullScreenSearchBar component for SearchBar. This component marks its children to be rendered in the expanded full-screen search bar.

`SearchBar`

Android

Type: React.Element<SearchBarProps>

Renders a SearchBar component.

SearchBarProps

`children`

Android

Optional • Type: ReactNode

The children of the component.

`modifiers`

Android

Optional • Type: ModifierConfig[]

Modifiers for the component.

`onSearch`

Android

Optional • Type: (searchText: string) => void

Callback function that is called when the search text is submitted.

`SearchBarPlaceholder`

Android

Type: React.Element<PlaceholderProps>

Placeholder component for SearchBar. This component marks its children to be rendered in the placeholder slot.