Skip to content

Checkbox

Checkbox

Form input component for selecting one or multiple options from a set.

Import

import { CheckboxComponent } from '@primitivekit/angular';

Basic Usage

<pk-checkbox>Content</pk-checkbox>

Props

No props available.

Customization

The Checkbox component supports CSS variables for complete customization:

<pk-checkbox [style]="{
  '--checkbox-bg-color': '#007bff',
  '--checkbox-text-color': '#ffffff'
}">Custom</pk-checkbox>

Design Tokens

The following design tokens are available for customization:

  • --checkbox-size
  • --checkbox-border-width
  • --checkbox-border-color
  • --checkbox-border-radius
  • --checkbox-border-color-hover
  • --checkbox-border-color-checked
  • --checkbox-bg-color
  • --checkbox-bg-color-checked
  • --checkbox-checkmark-color
  • --checkbox-label-gap
  • … and 8 more

Accessibility

The Checkbox component is fully accessible and follows WCAG 2.1 AA standards:

  • ✅ Semantic HTML elements
  • ✅ Keyboard accessible
  • ✅ Focus visible indicator
  • ✅ Proper ARIA attributes
  • ✅ Screen reader compatible
  • ✅ Touch target size (44x44px minimum)
  • ✅ Color contrast compliance

Keyboard Navigation

KeyAction
TabMove focus to/from component
EnterActivate component
SpaceActivate component

Related Components

  • Button - Interactive button component with multiple variants, sizes, and states for triggering actions.
  • Input - Text input field component with validation, icons, and various input types.
  • Select - Dropdown component for selecting one or multiple options from a list.
  • Radio - Form input component for selecting a single option from a set of mutually exclusive choices.
  • Switch - Toggle component for switching between two states, typically on/off or enabled/disabled.

See Also