注釈DocNoteExperimental
本文中の補足説明、参考リンク、緊急ではない注釈を表示します。
プレビュー
状態とバリエーション
通常
本文の流れを止めずに、補足説明や用語説明を背景色だけで本文から分けます。
参考リンク
外部資料や判断根拠を本文から少し分けて示します。
プロパティ
表は横にスクロールできます
| プロパティ | 型 | 初期値 | 説明 |
|---|---|---|---|
| heading | ReactNode | - | 注釈の短い見出しです。 |
| variant | "default" | "reference" | "default" | 補足説明か参考リンクかに合わせた見た目です。 |
| children | ReactNode | - | 注釈本文です。 |
| className | string | - | 必要に応じて外側に追加するクラスです。 |
使い方
import { DocNote } from "@gunjo/ui";
export function Example() {
return (
<DocNote heading="GitHub Flavored Markdown の拡張">
GFM は標準 Markdown に表、チェックリスト、取り消し線などを加えた記法です。
</DocNote>
);
}