Actions
Toggle
Keeps the pressed state of a tool action such as pin, mute, or bold.
01
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
View Toggle code
Framework usage
Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.---
import { Toggle } from '@santi020k/lumen-astro'
---
<Toggle>Pin project</Toggle>
<Toggle pressed>Starred</Toggle>
<Toggle disabled>Archived (disabled)</Toggle>import { Toggle } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Toggle>Pin project</Toggle>
<Toggle pressed>Starred</Toggle>
<Toggle disabled>Archived (disabled)</Toggle>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-toggle>Pin project</lumen-toggle>
<lumen-toggle pressed>Starred</lumen-toggle>
<lumen-toggle disabled>Archived (disabled)</lumen-toggle>02
Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add Togglelumen add Togglepnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Toggle --target reactlumen add Toggle --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Toggle --target elementslumen add Toggle --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.
| Attribute | Values | Default | Description |
|---|---|---|---|
| controlled | boolean | false | Disables automatic Astro state changes while retaining the cancelable ui:toggle-intent event. |
| pressed | boolean | false | Sets the initial pressed state. |
| type | "button" | "submit" | "reset" | "button" | Sets the native button type. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |