Checkbox checkbox link

Full documentation: https://webawesome.com/docs/components/checkbox

<wa-checkbox> Stable Since 2.0

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.

<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 examples link

Checked checked link

Use the checked attribute to activate the checkbox.

<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 indeterminate link

Use the indeterminate attribute to make the checkbox indeterminate.

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

Disabled disabled link

Use the disabled attribute to disable the checkbox.

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

Sizes sizes link

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

<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 hint link

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

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

Custom Validity custom validity link

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.

<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 importing link

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**

Import this component directly from the CDN:

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

**npm**

After installing Web Awesome via npm, import this component:

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

**Self-Hosted**

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

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

**React**

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 slots link

Learn more about using slots.

Attributes & Properties attributes properties link

Learn more about attributes and properties.

` By default, form controls are associated with the nearest containing 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 | `hint` The checkbox’s . If you need to display HTML, use the hint slot instead. Type string Default ‘’ | | | | `indeterminate` indeterminate | `boolean` 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 Default false | | | | `name` name | `string \| null` The name of the checkbox, submitted as a name/value pair with form data. Type Default null | | | | `required` required | `boolean` Makes the checkbox a required field. Type Default false | | | | `size` size | `‘xs’ \| ‘s’ \| ‘m’ \| ‘l’ \| ‘xl’ \| ‘small’ \| ‘medium’ \| ‘large’` The checkbox’s size. Type Default ‘m’ | | | | `validationTarget` | `undefined \| HTMLElement` Override this to change where constraint validation popups are anchored. Type | | | | `validators` | `observedAttributes` Validators are static because they have , essentially attributes to “watch” for changes. Whenever these attributes change, we want to be notified and update the validator. Type Validator[] Default [] | | | | `value` value | `string \| null` The value of the checkbox, submitted as a name/value pair with form data. Type | | |

Methods methods link

Learn more about methods.

Events events link

Learn more about events.

CSS custom properties css custom properties link

Learn more about CSS custom properties.

Custom States custom states link

Learn more about custom states.

CSS parts css parts link

Learn more about CSS parts.

Dependencies dependencies link

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