Drawer

Open settings

导入

import {
  Drawer,
  DrawerTrigger,
  DrawerContent,
  DrawerHeader,
  DrawerTitle,
  DrawerDescription,
  DrawerBody,
  DrawerFooter,
} from "@pelagornis/page/components";

示例

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

src/components/DrawerExample.tsx

import { useState } from "react";
import {
  Button,
  Drawer,
  DrawerBody,
  DrawerContent,
  DrawerDescription,
  DrawerFooter,
  DrawerHeader,
  DrawerTitle,
  DrawerTrigger,
  Switch,
  Stack,
  Text,
} from "@pelagornis/page/components";

export default function DrawerDemo() {
  const [open, setOpen] = useState(false);

  return (
    <Drawer open={open} onOpenChange={setOpen} placement="right">
      <DrawerTrigger variant="outline">Open settings</DrawerTrigger>
      <DrawerContent>
        <DrawerHeader>
          <DrawerTitle>Settings</DrawerTitle>
          <DrawerDescription>Preferences for this workspace.</DrawerDescription>
        </DrawerHeader>
        <DrawerBody>
          <Stack direction="row" gap="sizeSmall" align="center">
            <Switch aria-label="Compact sidebar" />
            <Text variant="bodyMd">Compact sidebar</Text>
          </Stack>
        </DrawerBody>
        <DrawerFooter>
          <Button variant="outline" onClick={() => setOpen(false)}>
            Cancel
          </Button>
          <Button variant="primary" onClick={() => setOpen(false)}>
            Save
          </Button>
        </DrawerFooter>
      </DrawerContent>
    </Drawer>
  );
}

在 MDX 中使用

Drawer 由共享 React 状态的多个部件组成。写在 MDX 中的子元素会各自渲染成独立的岛，部件之间无法互通。请像上面的示例一样在 .tsx 文件中组合，再导入该文件。

src/content/docs/example.mdx

---
title: Example
---

import DrawerExample from "../../components/DrawerExample";

<DrawerExample client:load />

client:load 会在页面加载时水合该岛。位于页面靠下位置的内容请使用 client:visible。

在 Markdoc 中使用

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

src/components/markdoc/DrawerExample.astro

---
import DrawerExample from "../DrawerExample";
---

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

src/content/docs/example.mdoc

{% drawer-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
type	overlay inline
size	sm md lg

结构

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

部件	角色
root	drawer

状态

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

类型	状态
data-state	open closed

键盘

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

按键	动作
Escape	close

参考

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