diff --git a/src/components/base/form/form_checkbox/form_checkbox.md b/src/components/base/form/form_checkbox/form_checkbox.md index 05fab872701f33798858a0ef57bac9fde40a5eb3..cc710b2776f6320ec5615466d3db841d331b0226 100644 --- a/src/components/base/form/form_checkbox/form_checkbox.md +++ b/src/components/base/form/form_checkbox/form_checkbox.md @@ -1,6 +1,181 @@ -Form checkbox groups for general use inside forms. +`` and `` implement custom checkbox inputs that ensure +consistent appearance across all browsers while maintaining the semantic structure and +accessibility of native elements, making them robust replacements for default browser checkboxes. ## Stacked By default, the GitLab Design guide mandates the `` be `stacked` and is non-changeable at this time. + +## Checkbox group options array + +`options` can be an array of strings or objects. Available fields: + +- `value` The selected value which will be set on `v-model` +- `disabled` Disables item for selection +- `text` Display text, or `html` Display basic inline html + +`value` can be a string, number, or simple object. Avoid using complex types in values. + +If both `html` and `text` are provided, `html` will take precedence. Only basic/native HTML is +supported in the `html` field (components will not work). Note that not all browsers will render +inline html (i.e. ``, ``, etc.) inside `