Switch

Auto update is on

インポート

import { Switch, Toggle } from "@pelagornis/page/components";

例

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

src/components/SwitchExample.tsx

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

export default function SwitchDemo() {
  const [enabled, setEnabled] = useState(true);

  return (
    <Stack direction="row" gap="sizeSmall" align="center">
      <Switch checked={enabled} onCheckedChange={setEnabled} aria-label="Auto update" />
      <Text variant="bodyMd">Auto update is {enabled ? "on" : "off"}</Text>
    </Stack>
  );
}

MDX で使う

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

src/content/docs/example.mdx

---
title: Example
---

import SwitchExample from "../../components/SwitchExample";

<SwitchExample client:load />

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

Markdoc で使う

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

src/components/markdoc/SwitchExample.astro

---
import SwitchExample from "../SwitchExample";
---

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

src/content/docs/example.mdoc

{% switch-example /%}

構造

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

パーツ	ロール
root	switch

状態

コンポーネントがスタイルを当てる状態です。コンポーネントの状態は data 属性として公開されます。

種類	状態
疑似クラス	focus-visible

キーボード

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

キー	動作
Enter	activate
Space	activate

参考

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