Checkbox widget

The Checkbox widget allows the rendering of checkbox input elements, enabling users to select or deselect options within your application for convenient and interactive data manipulation.

Test in Kitchen Sink (opens in a new tab)

Properties

Property	Type	Description
id	string	ID to be referenced later
maxWidth	integer	The max width of this Input widget (default 700). while min vlaue can be `0` and maximum can be `5000`
label	string	Label for your widget
labelHint	string	Hint text on your label
hintText	string	Hint text explaining your widget
required	boolean	Whether the field is required
enabled	boolean	Enables or disables the interactivity and input functionality of the widget
icon	object	See properties
onChange	action	Call Ensemble's built-in functions or execute code when the input changes. Note for free-form text input, this event only dispatches if the text changes AND the focus is lost (e.g. clicking on button)
value	boolean	true if checkbox is checked else otherwise
autoComplete	boolean	Enable the Input search suggestion option
items	array	List of values, or Objects with value/label pairs
leadingText	string	Sets the text displayed before the checkbox
trailingText	string	Sets the text displayed after the checkbox

Styles

Common Properties

Property	Type	Description
variant	string	Select a pre-defined look and feel for this Input widget. This property can be defined in the theme to apply to all Input widgets. see properties

Stack Position Properties

Property	Type	Description
stackPositionTop	integer	The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children.
stackPositionBottom	integer	The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children.
stackPositionLeft	integer	The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children.
stackPositionRight	integer	The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children.

Border Properties

Property	Type	Description
errorBorderColor	integer or string	The border color when there are errors on this input field. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange
focusedBorderColor	integer or string	The border color when this input field is receiving focus. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange
focusedErrorBorderColor	integer or string	The border color of this input field when it is receiving focus in its error state. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange
disabledBorderColor	integer or string	The border color when this input field is disabled. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange
fillColor	integer or string	The fill color for this input fields. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange

Padding Properties

Property	Type	Description
contentPadding	integer or string	Padding around your input content with CSS-style notation, e.g., margin: 5 20 5.

Box Styles (Inherited)

This widget also inherits these styles

Property	Type	Description
margin	integer/string	Margin with CSS-style notation (1 to 4 integers) e.g. margin: 5 20 5
padding	integer/string	Padding with CSS-style notation (1 to 4 integers) e.g. padding: 5 20 5
backgroundColor	Color	The background color of this widget.
backgroundImage	BackgroundImage	The background image of this widget.
backgroundGradient	Gradient	The background gradient of this widget.
border	Border	The border of this widget.
shadow	Shadow	The shadow of this widget
clipContent	boolean	Some widgets (such as Image) may bleed through the container when borderRadius is set. Use this to apply a clipping to ensure this does not happen.
width	integer	The width of this widget.
height	integer	The height of this widget.
borderRadius	string or integer	The border radius of the widget. This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0.
borderColor	integer or string	Sets the border color, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange.
borderWidth	integer	Thickness of the border. Minimum value should be 0.
shadowColor	integer or string	Sets the box shadow color starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange.
shadowOffset	array	The values in the array define the horizontal and vertical offset of the shadow. Example: if the shadowOffset is set to [2, 4], the shadow will be offset by 2 pixels horizontally and 4 pixels vertically from its original position.
shadowRadius	string or integer	The border radius of the widget. This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0.
shadowStyle	string	The blur style to apply on the shadow: normal, solid, outer, inner.

Base Styles (Inherited)

This widget also inherits these styles

Property	Type	Description
visible	boolean	Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified.
visibilityTransitionDuration	number	Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible.
elevation	integer	The z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. (Minimum: 0, Maximum: 24)
elevationShadowColor	Color	The shadow color for the elevation.
elevationBorderRadius	integer / string	If the widget has a borderRadius, this should be changed to have the same value. Use with CSS-like notation (1 to 4 integers).
alignment	Alignment	Align this widget relative to its parent.
stackPositionTop	integer	The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children.
stackPositionBottom	integer	The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children.
stackPositionLeft	integer	The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children.
stackPositionRight	integer	The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children.
captureWebPointer	boolean	Applicable for Web only. When overlaying widgets on top of certain HTML container (e.g., Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget.

Icon

Property	Type	Description
name	string	The name of the icon
library	string	Which icon library to use.
color	integer or string	The color specification for the text, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
size	integer	Defines the dimensions or magnitude of an element, allowing control over its overall size within the layout.

Carousel Column