Checkbox

Usage

A special button that enables the user to select or deselect a value, usually within a set of options.

JSON structure example

"viewDefinition": {
    "children": {
        "checkComponent": {
            "type": "checkbox",
            "id": "someId",
            "disabled": true,
            "size": "default",
            "mixed": true,
            "name": "someName",
            "value": "bananas",
            "text": "Some cool text"
        }
    }
}

• type (String) - the type attribute for a checkbox
• id (String) - an id for the component
• disabled (Boolean) - set to true in order to disable the component
  • Default: false
• size (String) (Optional) - defines the size of the component, choose from:
• Allowed values: {default, small}
• Default: default
• mixed (Boolean) - Set to true to indicate partial check for elements that have tri states
• name (String) - Name for component
• text (String) - Label text
• value (String) - Value provided enabling checkbox

Do's and Don'ts

For more details, refer to Checkbox Usage and Visual styleguides in our Storybook