@mozaic-ds/vue
Version:
Mozaic-Vue is the Vue.js implementation of ADEO Design system
21 lines (14 loc) • 1.39 kB
Markdown
# MCheckboxGroup
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` | - |
| `modelValue` | Property used to manage the values checked by v-model
(Do not use directly) | `string[]` | - |
| `options*` | list of properties of each checkbox button of the checkbox group | `{ id: string; label: string; value: string; disabled?: boolean` `undefined; isInvalid?: boolean` `undefined; indented?: boolean` `undefined; }[]` | - |
| `inline` | If `true`, make the form element of the group inline. | `boolean` | - |
## Events
| Name | Description | Type |
| --- | --- | --- |
| `update:modelValue` | Emits when the checkbox group value changes, updating the modelValue prop. | [value: Array<string>] |