Dialog

Delete page

导入

import {
  Dialog,
  DialogTrigger,
  DialogContent,
  DialogHeader,
  DialogTitle,
  DialogDescription,
  DialogClose,
} from "@pelagornis/page/components";

示例

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

src/components/DialogExample.tsx

import { useState } from "react";
import {
  Button,
  Dialog,
  DialogContent,
  DialogDescription,
  DialogHeader,
  DialogTitle,
  DialogTrigger,
  Stack,
} from "@pelagornis/page/components";

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

  return (
    <Dialog size="sm" open={open} onOpenChange={setOpen}>
      <DialogTrigger variant="primary">Delete page</DialogTrigger>
      <DialogContent>
        <DialogHeader>
          <DialogTitle>Delete this page?</DialogTitle>
          <DialogDescription>The page and its translations are removed from the sidebar.</DialogDescription>
        </DialogHeader>
        <Stack direction="row" gap="sizeSmall" justify="end">
          <Button variant="outline" onClick={() => setOpen(false)}>
            Cancel
          </Button>
          <Button variant="primary" onClick={() => setOpen(false)}>
            Delete
          </Button>
        </Stack>
      </DialogContent>
    </Dialog>
  );
}

在 MDX 中使用

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

src/content/docs/example.mdx

---
title: Example
---

import DialogExample from "../../components/DialogExample";

<DialogExample client:load />

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

在 Markdoc 中使用

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

src/components/markdoc/DialogExample.astro

---
import DialogExample from "../DialogExample";
---

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

src/content/docs/example.mdoc

{% dialog-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
size	sm lg

结构

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

部件	角色
root	dialog
scrim	presentation
panel	panel
header	header
title	title
description	description
body	content
close	close

状态

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

类型	状态
伪类	focus-visible
data-state	open closed

键盘

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

按键	动作
Escape	close

参考

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