Documentation
Actions
Toggle
Keeps the pressed state of a tool action such as pin, mute, or bold.
01
See it in context
Preview
02
Copy a working example
Usage
---
import { Toggle } from '@santi020k/lumen-astro'
---
<Toggle>Pin project</Toggle>
<Toggle pressed>Starred</Toggle>
<Toggle disabled>Archived (disabled)</Toggle>---
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>
</>
)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><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>03
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. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.
| Attribute | Values | Default | Description |
|---|---|---|---|
| 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. |