Switch

Auto update is on

Import

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

Example

The preview above renders this file. Copy it into src/components/ to start from it.

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>
  );
}

Use in MDX

Switch is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

src/content/docs/example.mdx

---
title: Example
---

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

<SwitchExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Use in Markdoc

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

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 /%}

Anatomy

Parts of the component and the data-refineui role each one renders.

Part	Role
root	switch

States

States the component styles. Component states are exposed as data attributes.

Kind	States
Pseudo	focus-visible

Keyboard

Keys the component handles when it has focus.

Key	Action
Enter	activate
Space	activate

Reference

• RefineUI · Switch for design guidance and token detail.
• Use in MDX and Use in Markdoc for the general rules.