Tooltip

ホバーやフォーカスで表示される短いヒントです。

インポート

import { Tooltip } from "@pelagornis/page/components";

例

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

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

export default function TooltipDemo() {
  return (
    <Stack direction="row" gap="sizeSmall" wrap>
      <Tooltip trigger={<Button variant="outline">Top</Button>} content="Shown above" position="Top" />
      <Tooltip trigger={<Button variant="outline">Bottom</Button>} content="Shown below" position="Bottom" />
      <Tooltip trigger={<Button variant="outline">Right</Button>} content="Shown on the right" position="Right" />
    </Stack>
  );
}

MDX で使う

Tooltip は React の状態を共有する複数のパーツで構成されます。MDX に書いた子要素はそれぞれ別のアイランドとして描画されるため、パーツ同士がつながりません。上の例のように .tsx ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

import TooltipExample from "../../components/TooltipExample";

<TooltipExample client:load />

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

Markdoc で使う

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

---
import TooltipExample from "../TooltipExample";
---

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

{% tooltip-example /%}

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
`root`	tooltip

キーボード

フォーカスがあるときにコンポーネントが処理するキーです。

キー	動作
`Escape`	close

参考

デザインのガイドとトークンの詳細は RefineUI · Tooltip を参照してください。
共通のルールは MDX で使うと Markdoc で使うを参照してください。