Checkbox

<wa-checkbox>

Since 2.0

stable

Checkboxes allow the user to toggle an option on or off.

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 Jump to heading

Checked Jump to heading

Use the checked attribute to activate the checkbox.

Checked

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

Indeterminate Jump to heading

Use the indeterminate attribute to make the checkbox indeterminate.

Indeterminate

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

Disabled Jump to heading

Use the disabled attribute to disable the checkbox.

Disabled

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

Sizes Jump to heading

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

                Small

Medium

Large

<wa-checkbox size="small">Small</wa-checkbox>
<br />
<wa-checkbox size="medium">Medium</wa-checkbox>
<br />
<wa-checkbox size="large">Large</wa-checkbox>

Hint Jump to heading

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 Jump to heading

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 type="submit" variant="brand" 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 Jump to heading

Autoloading components via projects is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.

CDN

npm

React

Let your project code do the work! Sign up for free to use a project with your very own CDN — it's the fastest and easiest way to use Web Awesome.

To manually import this component from NPM, use the following code.

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

To manually import this component from React, use the following code.

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

Slots Jump to heading

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 Jump to heading

Learn more about attributes and properties.

Name	Description	Reflects
`checked`	Draws the checkbox in a checked state. Type `boolean`
`css`	One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended. Type `CSSResultGroup \| undefined` Default `[formControlStyles, sizeStyles, styles]`
`customStates`	Methods for setting and checking custom states. Type `object` Default { /** Adds or removes the specified custom state. / set: (customState: string, active: boolean) => { if (!Boolean(this.internals?.states)) return; try { if (active) { this.internals.states.add(customState); } else { this.internals.states.delete(customState); } } catch (e) { if (String(e).includes("must start with '--'")) { / eslint-disable-next-line / console.error('Your browser implements an outdated version of CustomStateSet. Consider using a polyfill'); } else { throw e; } } }, /* Determines whether or not the element currently has the specified state. */ has: (customState: string) => { if (!Boolean(this.internals?.states)) return false; try { return this.internals.states.has(customState); } catch { return false; } }, }
`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 checkbox, submitted as a name/value pair with form data. Type `string \| null` Default `''`
`required` `required`	Makes the checkbox a required field. Type `boolean` Default `false`
`size` `size`	The checkbox's size. Type `'small' \| 'medium' \| 'large'` Default `'medium'`
`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 Jump to heading

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'`
`relayNativeEvent()`	Given a native event, this function cancels it and dispatches it again from the host element using the desired event options.	`event: Event, eventOptions: EventInit`
`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 Jump to heading

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 Jump to heading

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 Jump to heading

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 Jump to heading

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 Jump to heading

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

Getting Started

Resources

Components

Style Utilities

Layout

Patterns

Theming

Design Tokens

Terms & Policies

Web Awesome

Checkbox

Examples Jump to heading

Checked Jump to heading

Indeterminate Jump to heading

Disabled Jump to heading

Sizes Jump to heading

Hint Jump to heading

Custom Validity Jump to heading

Importing Jump to heading

Slots Jump to heading

Attributes & Properties Jump to heading

Methods Jump to heading

Events Jump to heading

CSS custom properties Jump to heading

Custom States Jump to heading

CSS parts Jump to heading

Dependencies Jump to heading

Getting Started

Resources

Components

Style Utilities

Layout

Patterns

Theming

Design Tokens

Terms & Policies

Web Awesome

Web Awesome Elsewhere

Checkbox

Examples Jump to heading

Checked Jump to heading

Indeterminate Jump to heading

Disabled Jump to heading

Sizes Jump to heading

Hint Jump to heading

Custom Validity Jump to heading

Importing Jump to heading

Slots Jump to heading

Attributes & Properties Jump to heading

Methods Jump to heading

Events Jump to heading

CSS custom properties Jump to heading

Custom States Jump to heading

CSS parts Jump to heading

Dependencies Jump to heading