[ { "name": "describedBy", "type": "string", "required": false, "description": "One or more element IDs to add to the input `aria-describedby` attribute without a fieldset, used to provide additional descriptive information for screenreader users." }, { "name": "fieldset", "type": "object", "required": false, "description": "Options for the fieldset component (for example legend).", "isComponent": true }, { "name": "hint", "type": "object", "required": false, "description": "Options for the hint component (for example text).", "isComponent": true }, { "name": "errorMessage", "type": "object", "required": false, "description": "Options for the error message component. The error message component will not display if you use a falsy value for `errorMessage`, for example `false` or `null`.", "isComponent": true }, { "name": "formGroup", "type": "object", "required": false, "description": "Options for the form-group wrapper", "params": [ { "name": "classes", "type": "string", "required": false, "description": "Classes to add to the form group (for example to show error state for the whole group)" } ] }, { "name": "idPrefix", "type": "string", "required": false, "description": "String to prefix id for each checkbox item if no id is specified on each item. If not passed, fall back to using the name option instead." }, { "name": "name", "type": "string", "required": true, "description": "Name attribute for all checkbox items." }, { "name": "items", "type": "array", "required": true, "description": "Array of checkbox items objects.", "params": [ { "name": "text", "type": "string", "required": true, "description": "If `html` is set, this is not required. Text to use within each checkbox item label. If `html` is provided, the `text` argument will be ignored." }, { "name": "html", "type": "string", "required": true, "description": "If `text` is set, this is not required. HTML to use within each checkbox item label. If `html` is provided, the `text` argument will be ignored." }, { "name": "id", "type": "string", "required": false, "description": "Specific id attribute for the checkbox item. If omitted, then component global `idPrefix` option will be applied." }, { "name": "name", "type": "string", "required": false, "description": "Specific name for the checkbox item. If omitted, then component global `name` string will be applied." }, { "name": "value", "type": "string", "required": true, "description": "Value for the checkbox input." }, { "name": "label", "type": "object", "required": false, "description": "Provide attributes and classes to each checkbox item label.", "isComponent": true }, { "name": "hint", "type": "object", "required": false, "description": "Provide hint to each checkbox item.", "isComponent": true }, { "name": "divider", "type": "string", "required": false, "description": "Divider text to separate checkbox items, for example the text \"or\"." }, { "name": "checked", "type": "boolean", "required": false, "description": "If true, checkbox will be checked." }, { "name": "conditional", "type": "boolean", "required": false, "description": "If true, content provided will be revealed when the item is checked." }, { "name": "conditional.html", "type": "string", "required": false, "description": "Provide content for the conditional reveal." }, { "name": "behaviour", "type": "string", "required": false, "description": "If set to `exclusive`, implements a \"None of these\" type behaviour via javascript when checkboxes are clicked" }, { "name": "disabled", "type": "boolean", "required": false, "description": "If true, checkbox will be disabled." }, { "name": "attributes", "type": "object", "required": false, "description": "HTML attributes (for example data attributes) to add to the checkbox input tag." } ] }, { "name": "classes", "type": "string", "required": false, "description": "Classes to add to the checkboxes container." }, { "name": "attributes", "type": "object", "required": false, "description": "HTML attributes (for example data attributes) to add to the anchor tag." } ]