Docs/Presentations/Checkbox

Checkbox

Presentations v1.0 zero-schema

No description provided.

Required fields

PresentationType Name

Properties

PresentationType string required

Indicates the type of presentation for the component. It can be a single checkbox or a list of checkboxes.

Allowed Checkbox

Name string required

Represents the name of the checkbox component that identifies the checkbox.

Default "Undefined"

Label string optional

The label specifies the description of checkbox.

EnableSelectAll boolean optional

A boolean flag to enable or disable the Select All functionalities for a checkbox.

Default false

IsTile boolean optional

Species wheather a checkbox is displayed as tile.

Default false

LabelColor string, object optional

The color of checkbox label or description. Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

Default "black"

ActiveColor string, object optional

The color applied to checkbox container when it is in active state. Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

Default "#531A5A"

CheckColor string, object optional

The color of checkbox itself when it is checked. Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

Default "white"

{ "$id": "/schema/Presentations/Checkbox/1.0/index.json", "type": "object", "title": "Checkbox", "$schema": "http://json-schema.org/draft-07/schema#", "required": [ "PresentationType", "Name" ], "properties": { "PresentationType": { "enum": [ "Checkbox" ], "type": "string", "description": "Indicates the type of presentation for the component. It can be a single checkbox or a list of checkboxes." }, "Name": { "type": "string", "default": "Undefined", "description": "Represents the name of the checkbox component that identifies the checkbox." }, "Label": { "type": "string", "description": "The label specifies the description of checkbox." }, "EnableSelectAll": { "type": "boolean", "default": false, "description": "A boolean flag to enable or disable the Select All functionalities for a checkbox." }, "IsTile": { "type": "boolean", "default": false, "description": "Species wheather a checkbox is displayed as tile." }, "LabelColor": { "type": [ "string", "object" ], "default": "black", "description": "The color of checkbox label or description. Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"}).", "x-editor": "color" }, "ActiveColor": { "type": [ "string", "object" ], "default": "#531A5A", "description": "The color applied to checkbox container when it is in active state. Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"}).", "x-editor": "color" }, "CheckColor": { "type": [ "string", "object" ], "default": "white", "description": "The color of checkbox itself when it is checked. Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"}).", "x-editor": "color" } }, "x-icon": "<svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"1.7\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><rect x=\"4\" y=\"4\" width=\"16\" height=\"16\" rx=\"3\"/><path d=\"M8 12l3 3 5-6\"/></svg>", "x-family": "Presentations", "x-name": "Checkbox", "x-version": "1.0", "x-source-package": "zero-schema" }