Checkbox

<wa-checkbox>

Stable

Checkboxes let users toggle an option on or off, or select multiple items from a list. They also support an indeterminate state for partial selections in groups.

Checkbox

<wa-checkbox>Checkbox</wa-checkbox>

This component works with standard <form> elements. Please refer to the section on form controls to learn more about form submission and client-side validation.

Examples

Link to This Section

Checked

Link to This Section

Use the checked attribute to activate the checkbox.

Checked

<wa-checkbox checked>Checked</wa-checkbox>

The checked attribute is the initial value and does not reflect changes, consistent with native checkboxes. To toggle the checked state with JavaScript, use the checked property instead. To target checked checkboxes with CSS, use the :state(checked) selector.

Indeterminate

Link to This Section

Use the indeterminate attribute to make the checkbox indeterminate.

Indeterminate

<wa-checkbox indeterminate>Indeterminate</wa-checkbox>

Disabled

Link to This Section

Use the disabled attribute to disable the checkbox.

Disabled

<wa-checkbox disabled>Disabled</wa-checkbox>

Sizes

Link to This Section

Use the size attribute to change a checkbox's size.

Extra Small

Small

Medium

Large

Extra Large

<wa-checkbox size="xs">Extra Small</wa-checkbox>
<br />
<wa-checkbox size="s">Small</wa-checkbox>
<br />
<wa-checkbox size="m">Medium</wa-checkbox>
<br />
<wa-checkbox size="l">Large</wa-checkbox>
<br />
<wa-checkbox size="xl">Extra Large</wa-checkbox>

Hint

Link to This Section

Add descriptive hint to a switch with the hint attribute. For hints that contain HTML, use the hint slot instead.

Label

<wa-checkbox hint="What should the user know about the checkbox?">Label</wa-checkbox>

Custom Validity

Link to This Section

Use the setCustomValidity() method to set a custom validation message. This will prevent the form from submitting and make the browser display the error message you provide. To clear the error, call this function with an empty string.

  Check me
  
  Submit

<form class="custom-validity">
  <wa-checkbox>Check me</wa-checkbox>
  <br />
  <wa-button appearance="filled" type="submit" variant="neutral" style="margin-top: 1rem;">Submit</wa-button>
</form>
<script>
  const form = document.querySelector('.custom-validity');
  const checkbox = form.querySelector('wa-checkbox');
  const errorMessage = `Don't forget to check me!`;

  // Set initial validity as soon as the element is defined
  customElements.whenDefined('wa-checkbox').then(async () => {
    await checkbox.updateComplete;
    checkbox.setCustomValidity(errorMessage);
  });

  // Update validity on change
  checkbox.addEventListener('change', () => {
    checkbox.setCustomValidity(checkbox.checked ? '' : errorMessage);
  });

  // Handle submit
  customElements.whenDefined('wa-checkbox').then(() => {
    form.addEventListener('submit', event => {
      event.preventDefault();
      alert('All fields are valid!');
    });
  });
</script>

Importing

Link to This Section

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.

CDN

npm

Self-Hosted

React

Import this component directly from the CDN:

import 'https://ka-f.webawesome.com/webawesome@0.17.0/components/checkbox/checkbox.js';

After installing Web Awesome via npm, import this component:

import '@awesome.me/webawesome/dist/components/checkbox/checkbox.js';

If you're self-hosting Web Awesome, import this component from your server:

import './webawesome/dist/components/checkbox/checkbox.js';

To import this component for React 18 or below, use the following code:

import WaCheckbox from '@awesome.me/webawesome/dist/react/checkbox/index.js';

Slots

Link to This Section

Learn more about using slots.

Name	Description
(default)	The checkbox's label.
`hint`	Text that describes how to use the checkbox. Alternatively, you can use the `hint` attribute.

Attributes & Properties

Link to This Section

Learn more about attributes and properties.

Name	Description	Reflects
`checked`	Draws the checkbox in a checked state.
`defaultChecked` `checked`	The default value of the form control. Primarily used for resetting the form control. Type `boolean`
`disabled` `disabled`	Disables the checkbox. Type `boolean` Default `false`
`form`	By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you to place the form control outside of a form and associate it with the form that has this `id`. The form must be in the same document or shadow root for this to work. Type `HTMLFormElement \| null`
`hint` `hint`	The checkbox's hint. If you need to display HTML, use the `hint` slot instead. Type `string` Default `''`
`indeterminate` `indeterminate`	Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a "select all/none" behavior when associated checkboxes have a mix of checked and unchecked states. Type `boolean` Default `false`
`name` `name`	The name of the input, submitted as a name/value pair with form data. Type `string \| null` Default `null`
`required` `required`	Makes the checkbox a required field. Type `boolean` Default `false`
`size` `size`	The checkbox's size. Type `'xs' \| 's' \| 'm' \| 'l' \| 'xl' \| 'small' \| 'medium' \| 'large'` Default `'m'`
`validationTarget`	Override this to change where constraint validation popups are anchored. Type `undefined \| HTMLElement`
`validators`	Validators are static because they have `observedAttributes`, essentially attributes to "watch" for changes. Whenever these attributes change, we want to be notified and update the validator. Type `Validator[]` Default `[]`
`value` `value`	The value of the checkbox, submitted as a name/value pair with form data. Type `string \| null`

Methods

Link to This Section

Learn more about methods.

Name	Description	Arguments
`blur()`	Removes focus from the checkbox.
`click()`	Simulates a click on the checkbox.
`focus()`	Sets focus on the checkbox.	`options: FocusOptions`
`formStateRestoreCallback()`	Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue.	`state: string \| File \| FormData \| null, reason: 'autocomplete' \| 'restore'`
`resetValidity()`	Reset validity is a way of removing manual custom errors and native validation.
`setCustomValidity()`	Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators.	`message: string`

Events

Link to This Section

Learn more about events.

Name	Description
`blur`	Emitted when the checkbox loses focus.
`change`	Emitted when the checked state changes.
`focus`	Emitted when the checkbox gains focus.
`input`	Emitted when the checkbox receives input.
`wa-invalid`	Emitted when the form control has been checked for validity and its constraints aren't satisfied.

CSS Custom Properties

Link to This Section

Learn more about CSS custom properties.

Name	Description
`--checked-icon-color`	The color of the checked and indeterminate icons.
`--checked-icon-scale`	The size of the checked and indeterminate icons relative to the checkbox.

Custom States

Link to This Section

Learn more about custom states.

Name	Description	CSS selector
`checked`	Applied when the checkbox is checked.	`:state(checked)`
`disabled`	Applied when the checkbox is disabled.	`:state(disabled)`
`indeterminate`	Applied when the checkbox is in an indeterminate state.	`:state(indeterminate)`

CSS Parts

Link to This Section

Learn more about CSS parts.

Name	Description	CSS selector
`base`	The component's label .	`::part(base)`
`checked-icon`	The checked icon, a `<wa-icon>` element.	`::part(checked-icon)`
`control`	The square container that wraps the checkbox's checked state.	`::part(control)`
`hint`	The hint's wrapper.	`::part(hint)`
`indeterminate-icon`	The indeterminate icon, a `<wa-icon>` element.	`::part(indeterminate-icon)`
`label`	The container that wraps the checkbox's label.	`::part(label)`

Dependencies

Link to This Section

This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.

<wa-icon>

Need a hand?

Report a bug

Ask for help

Checkbox

Examples

Checked

Indeterminate

Disabled

Sizes

Hint

Custom Validity

Importing

Slots

Attributes & Properties

Methods

Events

CSS Custom Properties

Custom States

CSS Parts

Dependencies

Quick Links

Recent Searches