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 中使用。