# `m-checkbox-group`

A checkbox is an interactive component used to select or deselect an option, typically within a list of choices. It allows users to make multiple selections independently and is often accompanied by a label for clarity. Checkboxes are commonly used in forms, filters, settings, and preference selections to provide a simple and intuitive way to enable or disable specific options. <br><br> To put a label, requierement text, help text or to apply a valid or invalid message, the examples are available in the [Field section](/docs/form-elements-field--docs#input).

## Props

| Name | Description | Type | Default |
|------|-------------|------|---------|
| `name*` | The name attribute for the checkbox element, typically used for form submission. | `string` |   |
| `value` | The current value of the checkbox group. | `Array<string>` | `$bindable([])` |
| `options*` | list of properties of each checkbox button of the checkbox group | `Array<{ id: string; label: string; value: string; disabled?: boolean; indeterminate?: boolean; indented?: boolean; }>` |   |
| `isinvalid` | If `true`, applies an invalid state to the checkbox group. | `boolean` |   |
| `inline` | If `true`, make the form element of the group inline. | `boolean` |   |

