## `<w-checkbox-group>` API

Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).

### Properties

| Name | Type | Default | Summary |
|-|-|-|-|
| checkValidity (JS only) | `checkValidity() => boolean` | `-` | Checks whether the group passes constraint validation |
| focus (JS only) | `focus(options?: FocusOptions) => void` | `-` | Sets focus on the checkbox group. |
| help-text | `string \| undefined` | `-` | Help text displayed below the checkbox group. |
| invalid | `boolean` | `false` | Whether the checkbox group is visually invalid. |
| label | `string \| undefined` | `-` | The group label displayed above the checkboxes. |
| name | `string \| undefined` | `-` | The name applied to child checkboxes when they do not provide one. |
| optional | `boolean` | `false` | Whether to show optional text next to the label. |
| reportValidity (JS only) | `reportValidity() => boolean` | `-` | Checks validity and shows the validation message if invalid |
| required | `boolean` | `false` | Whether at least one checkbox in the group must be selected. |
| shadowRootOptions (JS only) | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |

### Property Details

#### checkValidity (JS only)

Checks whether the group passes constraint validation

- Type: `checkValidity() => boolean`
- Default: `-`

#### focus (JS only)

Sets focus on the checkbox group.

- Type: `focus(options?: FocusOptions) => void`
- Default: `-`

#### help-text

Help text displayed below the checkbox group.

Use this for supporting guidance or validation feedback. When required validation fails, the group replaces this text with the localized required message.

- Type: `string | undefined`
- Default: `-`

#### invalid

Whether the checkbox group is visually invalid.

Use this to show an externally managed validation error for the group. The invalid state is also shared with child checkboxes for consistent styling and accessibility state.

- Type: `boolean`
- Default: `false`

#### label

The group label displayed above the checkboxes.

Use this to describe the shared question or topic for the checkbox options. The label is connected to the internal group for assistive technologies.

- Type: `string | undefined`
- Default: `-`

#### name

The name applied to child checkboxes when they do not provide one.

Use this when the grouped checkboxes should submit values under the same form field name. Individual checkboxes can still override the group name with their own `name`.

- Type: `string | undefined`
- Default: `-`

#### optional

Whether to show optional text next to the label.

Use this to indicate that selecting an option from the group is not required.

- Type: `boolean`
- Default: `false`

#### reportValidity (JS only)

Checks validity and shows the validation message if invalid

- Type: `reportValidity() => boolean`
- Default: `-`

#### required

Whether at least one checkbox in the group must be selected.

Required validation is managed by the group. The individual checkboxes provide the submitted form values.

- Type: `boolean`
- Default: `false`

#### shadowRootOptions (JS only)



- Type: `object`
- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`

