Getting Started
Overview
Installation
Theme
Forms
Basic Inputs
Select
Custom Inputs
Components
Navigation
Components
69
Micro Charts
Libraries
Kanban Board
Image Designer
Video Player
Visual Builder
Content Editor
Data View
Latest npm version of @ngstarter-ui/componentsWeekly npm downloads of @ngstarter-ui/components
Purchase

Checkbox

The Checkbox component lets users turn an independent option on or off, or choose multiple options from a related set. Use it for preferences, permissions, checklist items, table row selection, required consent, and parent-child selection with an indeterminate state.

Use it for:
  • Independent choices: Enable or disable one option without affecting others.
  • Multiple selection: Let users select several values from a group.
  • Select all states: Use indeterminate when only some child items are selected.
  • Described options: Add a short explanation below the label when the choice needs context.

Do not use Checkbox for mutually exclusive choices, switch-style settings, compact mode groups, dropdown selection, or action buttons. Use Radio, Slide Toggle, Button Toggle, Segmented, Select, or Button for those cases.

PropTypeDefault
id
Unique identifier for the checkbox input.
stringngs-checkbox-n
name
Name value will be applied to the input element.
string | nullnull
value
The value attribute of the native input element.
string''
checked
Whether the checkbox is checked.
booleanfalse
disabled
Whether the checkbox is disabled.
booleanfalse
indeterminate
Whether the checkbox is indeterminate.
booleanfalse
required
Whether the checkbox is required.
booleanfalse
labelPosition
Whether the label should appear after or before the checkbox. Defaults to after.
'before' | 'after'after
color
Theme color palette for the component.
string | undefinedundefined
disableRipple
Whether ripples are disabled.
booleanfalse
disabledInteractive
Whether the checkbox should remain interactive when disabled.
booleanfalse
tabIndex
Tabindex for the checkbox.
number0
aria-label
Attached to the aria-label attribute of the host element.
string''
aria-labelledby
Attached to the aria-labelledby attribute of the host element.
string | nullnull
aria-describedby
Attached to the aria-describedby attribute of the host element.
string''
EventDescription
changeEvent emitted when the checkbox's `checked` value changes.
indeterminateChangeEvent emitted when the checkbox's `indeterminate` value changes.