Toast

Show successShow error

导入

import { Toaster, toast, dismissToast } from "@pelagornis/page/components";

示例

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

src/components/ToastExample.tsx

import { Button, Stack, Toaster, toast } from "@pelagornis/page/components";

export default function ToastDemo() {
  return (
    <Stack direction="row" gap="sizeSmall" wrap>
      <Button variant="primary" onClick={() => toast("Settings saved", { variant: "success", duration: 3000 })}>
        Show success
      </Button>
      <Button
        variant="outline"
        onClick={() =>
          toast("Upload failed", {
            variant: "error",
            action: { label: "Retry", onClick: () => toast("Retrying…") },
          })
        }
      >
        Show error
      </Button>
      <Toaster />
    </Stack>
  );
}

在 MDX 中使用

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

src/content/docs/example.mdx

---
title: Example
---

import ToastExample from "../../components/ToastExample";

<ToastExample client:load />

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

在 Markdoc 中使用

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

src/components/markdoc/ToastExample.astro

---
import ToastExample from "../ToastExample";
---

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

src/content/docs/example.mdoc

{% toast-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
variant	default success error warning

结构

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

部件	角色
root	toast
icon	toast-icon
item	toast-item
scale_layer	toast-scale-layer
toaster	toaster

参考

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