Search Field

带搜索图标和清除按钮的查询输入框。

Query: —

导入

import { SearchField } from "@pelagornis/page/components";

示例

上方预览渲染的就是这个文件。把它复制到 src/components/ 即可开始使用。

import { useState } from "react";
import { SearchField, Stack, Text } from "@pelagornis/page/components";

export default function SearchFieldDemo() {
  const [query, setQuery] = useState("");

  return (
    <Stack gap="sizeSmall" className="w-full max-w-sm">
      <SearchField value={query} onValueChange={setQuery} aria-label="Search components" />
      <SearchField appearance="plain" defaultValue="tokens" aria-label="Plain search" />
      <Text variant="captionMd">Query: {query || "—"}</Text>
    </Stack>
  );
}

在 MDX 中使用

Search Field 可以直接写在 .mdx 页面中。在 frontmatter 下方导入即可。它会响应输入，所以要加上 client:load 进行水合。

---
title: Example
---

import { SearchField } from "@pelagornis/page/components";

<SearchField client:load defaultValue="tokens" aria-label="Search" />

在 Markdoc 中使用

Markdoc 标签渲染的是 Astro 组件，而这个组件需要客户端状态。请把示例包进一个负责水合的 .astro 文件，再把该文件注册为标签。

---
import SearchFieldExample from "../SearchFieldExample";
---

<SearchFieldExample client:load />

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "search-field-example": {
      render: component("./src/components/markdoc/SearchFieldExample.astro"),
      selfClosing: true,
    },
  },
});

{% search-field-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
`appearance`	`filled` `plain`
`size`	`sm` `md` `lg`

结构

组件的组成部分，以及每个部分渲染的 data-refineui 角色。

部件	角色
`root`	search-field
`clear`	search-field-clear
`icon`	search-field-icon
`input`	search-field-input

状态

组件会设置样式的状态。组件状态通过 data 属性暴露。

类型	状态
伪类	`focus-visible`

键盘

组件获得焦点时处理的按键。

按键	动作
`Escape`	close

参考

设计指南和令牌细节见 RefineUI · Search Field。
通用规则见在 MDX 中使用和在 Markdoc 中使用。