Command

󰕈

インポート

import {
  Command,
  CommandInput,
  CommandList,
  CommandEmpty,
  CommandGroup,
  CommandGroupHeading,
  CommandItem,
  CommandSeparator,
  CommandDialog,
} from "@pelagornis/page/components";

例

上のプレビューはこのファイルを描画したものです。src/components/ にコピーして使い始めてください。

src/components/CommandExample.tsx

import {
  Command,
  CommandEmpty,
  CommandGroup,
  CommandGroupHeading,
  CommandInput,
  CommandItem,
  CommandList,
  CommandSeparator,
} from "@pelagornis/page/components";

export default function CommandDemo() {
  return (
    <Command label="Commands" className="w-full max-w-sm">
      <CommandInput placeholder="Search commands…" />
      <CommandList>
        <CommandEmpty>No results found.</CommandEmpty>
        <CommandGroup>
          <CommandGroupHeading>File</CommandGroupHeading>
          <CommandItem value="new" shortcut="⌘N">
            New file
          </CommandItem>
          <CommandItem value="open">Open</CommandItem>
        </CommandGroup>
        <CommandSeparator />
        <CommandGroup>
          <CommandGroupHeading>Edit</CommandGroupHeading>
          <CommandItem value="copy">Copy</CommandItem>
          <CommandItem value="paste">Paste</CommandItem>
        </CommandGroup>
      </CommandList>
    </Command>
  );
}

MDX で使う

Command は React の状態を共有する複数のパーツで構成されます。MDX に書いた子要素はそれぞれ別のアイランドとして描画されるため、パーツ同士がつながりません。上の例のように .tsx ファイルで組み立て、そのファイルをインポートしてください。

src/content/docs/example.mdx

---
title: Example
---

import CommandExample from "../../components/CommandExample";

<CommandExample client:load />

client:load はページの読み込み時にアイランドをハイドレートします。ページの下の方にあるコンテンツには client:visible を使ってください。

Markdoc で使う

Markdoc のタグは Astro コンポーネントを描画しますが、このコンポーネントにはクライアントの状態が必要です。例をハイドレートする .astro ファイルで包み、そのファイルをタグとして登録してください。

src/components/markdoc/CommandExample.astro

---
import CommandExample from "../CommandExample";
---

<CommandExample client:load />

markdoc.config.mjs

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: {
    "command-example": {
      render: component("./src/components/markdoc/CommandExample.astro"),
      selfClosing: true,
    },
  },
});

src/content/docs/example.mdoc

{% command-example /%}

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
root	command
empty	command-empty
group	command-group
group_heading	command-group-heading
indicator	command-indicator
input	command-input
item	command-item
list	command-list
separator	command-separator
shortcut	command-shortcut

状態

コンポーネントがスタイルを当てる状態です。コンポーネントの状態は data 属性として公開されます。

種類	状態
疑似クラス	focus-visible
data-state	disabled active default

キーボード

フォーカスがあるときにコンポーネントが処理するキーです。

キー	動作
ArrowDown	next-trigger
ArrowUp	previous-trigger
Home	first-trigger
End	last-trigger
Enter	activate

参考

• デザインのガイドとトークンの詳細は RefineUI · Command を参照してください。
• 共通のルールは MDX で使う と Markdoc で使う を参照してください。