Drawer

画面の端からスライドして出るパネルです。

インポート

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

例

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

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 ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

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

<DrawerExample client:load />

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

Markdoc で使う

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

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

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

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