VDS

Checkbox

Toggle between checked and unchecked states.

Installation

pnpm install @vds-testing/react @vds-testing/styles
pnpm install @vds-testing/elements @vds-testing/styles

See Installation for CSS setup.

Usage

React:

import { Checkbox } from "@vds-testing/react"
<Checkbox id="terms" />

Web Components:

<script type="module">
  import "@vds-testing/elements";
</script>
<vds-checkbox id="terms"></vds-checkbox>

Examples

Checked

Disabled

With description

Receive emails about new products and features.

Anatomy

  • Checkbox - A single form input element

Props

Checkbox

Prop Type Default Description
id string - Element ID for label association
name string - Form field name
checked boolean false Default checked state
disabled boolean false Disables the checkbox
required boolean false Makes the field required
value string - Form value when checked
class string - Additional CSS classes