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