Checkbox

Accept terms and conditions󰆘Enable notificationsReceive updates about releases󰆘CircularDisabled

インポート

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

例

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

src/components/CheckboxExample.tsx

import { useState } from "react";
import { Checkbox, Stack } from "@pelagornis/page/components";

export default function CheckboxDemo() {
  const [notify, setNotify] = useState(true);

  return (
    <Stack gap="sizeSmall">
      <Checkbox label="Accept terms and conditions" />
      <Checkbox
        label="Enable notifications"
        description="Receive updates about releases"
        checked={notify}
        onChange={(event) => setNotify(event.target.checked)}
      />
      <Checkbox variant="circular" label="Circular" defaultChecked />
      <Checkbox label="Disabled" disabled />
    </Stack>
  );
}

MDX で使う

Checkbox は .mdx ページにそのまま書けます。frontmatter の下でインポートしてください。サーバーで描画されるので、client ディレクティブは要りません。

src/content/docs/example.mdx

---
title: Example
---

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

<Checkbox label="Accept terms" description="Required to continue" />

Markdoc で使う

pageMarkdoc() がこのコンポーネントの checkbox タグを登録します。markdoc.config.mjs にプリセットを一度追加すれば（Markdoc で使うを参照）、どの .mdoc ページでもタグを書けます。

src/content/docs/example.mdoc

{% checkbox label="Accept terms" description="Required to continue" /%}

属性の名前と値は React の props と同じです。

バリアント

各 variant prop が受け付ける値です。

Prop	値
variant	default circular

構造

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

パーツ	ロール
root	checkbox

キーボード

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

キー	動作
Space	activate

参考

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