121
GitHub
Forms

Checkbox

Captures a binary form value.

FrameworksAstro · React · Elements

Registry commandlumen add Checkbox

InteractionNative markup

01

See it in context

Preview

02

Copy a working example

Usage

astro
---
import { Checkbox } from '@santi020k/lumen-astro'
---

<div style="display: grid; gap: 0.5rem;">
  <label>
    <Checkbox name="updates" /> Email me product updates
  </label>
  <label>
    <Checkbox checked name="terms" /> Accept terms (checked)
  </label>
  <label>
    <Checkbox id="ex-checkbox-indeterminate" name="permissions" /> Some permissions selected
  </label>
  <label>
    <Checkbox disabled name="legacy" /> Legacy option (disabled)
  </label>
</div>

<script>
  const checkbox = document.querySelector<HTMLInputElement>('#ex-checkbox-indeterminate')

  if (checkbox) {
    checkbox.indeterminate = true
  }
</script>
---
import { Checkbox } from '@santi020k/lumen-astro'
---

<div style="display: grid; gap: 0.5rem;">
  <label>
    <Checkbox name="updates" /> Email me product updates
  </label>
  <label>
    <Checkbox checked name="terms" /> Accept terms (checked)
  </label>
  <label>
    <Checkbox id="ex-checkbox-indeterminate" name="permissions" /> Some permissions selected
  </label>
  <label>
    <Checkbox disabled name="legacy" /> Legacy option (disabled)
  </label>
</div>

<script>
  const checkbox = document.querySelector<HTMLInputElement>('#ex-checkbox-indeterminate')

  if (checkbox) {
    checkbox.indeterminate = true
  }
</script>
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.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add Checkbox
lumen add Checkbox

API 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.

AttributeValuesDefaultDescription
checked, defaultCheckedboolean-Uses the native checkbox checked state.
type"checkbox""checkbox"Fixed by the component.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.