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 で使うを参照してください。