30 lines
1.1 KiB
Plaintext
30 lines
1.1 KiB
Plaintext
|
---
|
||
|
|
title: Overview
|
||
|
|
description: Understand the Search package data boundary, interactions, and use cases.
|
||
|
|
order: 1
|
||
|
|
toc:
|
||
|
|
- id: package-role
|
||
|
|
title: Package role
|
||
|
|
- id: capabilities
|
||
|
|
title: Capabilities
|
||
|
|
- id: design-boundary
|
||
|
|
title: Design boundary
|
||
|
|
---
|
||
|
|
|
||
|
|
## Package role {#package-role}
|
||
|
|
|
||
|
|
`@workspace/search` provides an application-search surface and its state management. The host supplies data through `SearchAdapter`; Search owns the query lifecycle, pagination, result presentation, selection interactions, and recent searches.
|
||
|
|
|
||
|
|
## Capabilities {#capabilities}
|
||
|
|
|
||
|
|
- Connect any HTTP API, database, command registry, or local index through an adapter.
|
||
|
|
- Present results in domain groups and merge paginated data.
|
||
|
|
- Cancel stale requests with `AbortSignal`.
|
||
|
|
- Keep recent searches with configurable local persistence.
|
||
|
|
- Provide a `Mod+K` shortcut plus empty, loading, and error states.
|
||
|
|
- Ship `en-US` and `zh-Hans` message catalogs.
|
||
|
|
|
||
|
|
## Design boundary {#design-boundary}
|
||
|
|
|
||
|
|
Search does not choose the data source or perform navigation. The application implements the adapter and interprets each result's `payload` in `onSelect`.
|