---
title: Checkbox
description: >-
  Give users a clear way to make selections, such as agreeing to terms or
  choosing multiple items from a list.
api_version: 2025-10
api_name: admin_extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-extensions/2025-10-rc/polaris-web-components/forms/checkbox
  md: >-
    https://shopify.dev/docs/api/admin-extensions/2025-10-rc/polaris-web-components/forms/checkbox.txt
---

# Checkbox

Give users a clear way to make selections, such as agreeing to terms or choosing multiple items from a list.

## Properties

* accessibilityLabel

  string

  A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.

* checked

  boolean

  Whether the control is active.

* defaultChecked

  boolean

  Whether the control is active by default.

* defaultIndeterminate

  boolean

* details

  string

  Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.

  This will also be exposed to screen reader users.

* disabled

  boolean

  Disables the field, disallowing any interaction.

* error

  string

  Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

* id

  string

  A unique identifier for the element.

* indeterminate

  boolean

* label

  string

  Visual content to use as the control label.

* name

  string

  An identifier for the field that is unique within the nearest containing form.

* required

  boolean

  Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.

* value

  string

  The value used in form data when the checkbox is checked.

## Events

Learn more about [registering events](https://shopify.dev/docs/api/app-home/using-polaris-components#event-handling).

* change

  CallbackEventListener<'input'>

* input

  CallbackEventListener<'input'>

### CallbackEventListener

```ts
(EventListener & {
      (event: CallbackEvent<T>): void;
    }) | null
```

### CallbackEvent

```ts
Event & {
  currentTarget: HTMLElementTagNameMap[T];
}
```

### Examples

* #### Code

  ##### Default

  ```html
  <s-checkbox
    label="Require a confirmation step"
    details="Ensure all criteria are met before proceeding"
  ></s-checkbox>
  ```