Checkbox
It is a small interactive box that the user can toggle to indicate the choice made by the user. Typically it is a two-options widget where the user would tick the box to say 'YES' and uncheck.
Basic
Manual
The list of options for the checkbox set. The set can contain a single checkbox, and more checkboxes can be added.
| Property | Description |
|---|---|
Label | The text to be displayed to represent the checkbox |
Value | The string value to refer the checkbox element. It is used during development typically. |
Disabled | Disables the user interaction with the checkbox option on the page. It visually indicates that the element is inactive and prevents users from interacting with it when applied |
Hide | This sets whether this checkbox option has to be displayed on the screen when the program is loaded. This shows/hides the option both on desktop and mobile devices. |
Map
Provide the JSON data of the array, consisting of the checkbox options list in the key-value pair format. This data must contain properties-values, like the Manualformat above, in the JSON format.
| Property | Description |
|---|---|
Label | The text to be displayed to represent the checkbox |
Value | The string value to refer the checkbox element. It is used during development typically. |
Disabled | Disables the user interaction with the checkbox option on the page. It visually indicates that the element is inactive and prevents users from interacting with it when applied |
Hide | This sets whether this checkbox option has to be displayed on the screen when the program is loaded. This shows/hides the option both on desktop and mobile devices. |
Default Value
Enter the default option to be checked when the widget is loaded. This can also be retrieved from the backend using query or loaded using low-code
Validation
Required Field
Refers to the field that must be completed by the user, which means the field must be entered with a valid value before submitting the information.
Custom Rule
Apart from validating the entry using the regex rule, users can also use this property to write low-code and check other aspects. For example - check if the city selected in the previous field matches the desired value, throw a custom message to the user even before capturing the entry on this field.
Interaction
Event Handlers
| Event | Description |
|---|---|
|
Disabled
Disables the user interaction with the element on the page. It visually indicates that the element is inactive and prevents users from interacting with it when applied. Shows a red-crossed warning symbol and can be customized to disable the widget according to certain conditions using low-code.
Hide
This sets whether the widget has to be displayed on the screen when the program is loaded. This shows/hides the widget both on desktop and mobile devices.
Layout
Options
| Property | Description |
|---|---|
Horizontal | The checkboxes are displayed as a series of options in a single line horizontally. |
Vertical | The checkboxes are displayed as a list, on top of one another, in a single column vertically. |
Auto Column | The checkboxes are auto-adjusted to fit in the widget area allocated on the screen. The options set is displayed horizontally and takes the consecutive rows according to the size of the list. |
Widget Tooltip
This tooltip pops up when the user moves the mouse over the input area of the widget. It is commonly used to hint at the type of input the user needs to provide.
The tooltip will be immediately shown when the user's mouse hovers over the widget, and immediately hides when the user's mouse leaves. This information will be contextual, useful, and informative.
Label
Represents the caption for the widget in the user interface. It is recommended to keep the label string short and convey the usage of the widget in the UI
Tooltip
This tooltip pops up when the user moves the mouse over the label area of the widget. This is commonly used to provide some extra or important information to the user on the usage of the widget.
The tooltip will be immediately shown when the user's mouse hovers over the widget, and immediately hides when the user's mouse leaves. This information will be contextual, useful, and informative.
Position
| Property | Description |
|---|---|
| |
|
Alignment
| Property | Description |
|---|---|
| |
|
Width
Enter a number value to set the width of the widget. It can be set in terms of pixels and percentage.
Style
| Property | Description |
|---|---|
Label | Set the colour for the label text. Recommended to set in contrast with the background. |
Static Text | Set the colour of the options' text. Recommended to set in contrast with the background. |
Validation Message | Set the colour of the validation text message. Recommended to set in contrast with the background, usually Red. |
Loader Color | Pick the colour to the loading spinner when the component shows the loader before getting displayed. |
Text Transform | This property specifies how to capitalize an element's text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized. MDN web docs |
Text Decoration | This property sets the appearance of decorative lines on text. Types are "underline", "overline", "line-though", "overline-underline". |
Text Size | Set the size of the text in px value - 12px |
Text Weight | Increase or decrease the thickness of the font using the list of numbers from 100-800. |
Font Family | Type the name of the font family. The reference to the list of font families can be found here: MDN web docs |
Font Style | There are 3 types of styles that can be applied: "normal" - The text is shown normally, no style applied. "italic" - The text is cursive. "oblique" - A sloped version of the normal text. |
Border Color | Set the colour to the border lines. The border lines will be shown only if that is enabled. |
Margin | This value is set in terms of "px" number which creates the space between the border and the content of the widget. |
Padding | This value is set in terms of "px" number which creates the space between the border and outer elements. |
Border Radius | This sets the radius of the widget's corners, enabling rounded corners on the widget. This value is defined in "px" terms. |
Border Width | Set the thickness of the border of the widget using this value. It is defined using "px" terms. |
Checked Background | Users can change the background colour of the checked-box using this property. It has all the RGB colour ranges to pick from. It is recommended to use a corresponding background colour that shows the font clearly. |
Unchecked Background | Set the background colour for the unchecked-box using this property. |
Unchecked Border | Set the border color for the unchecked-box using this property. |
Checked | Set the colour for the tick-mark used to indicate the checkbox is checked. Recommended to pick a color in contrast with the checkbox background colour. |
Box Shadow | The is the colour of the shadow that is generated behind the widget box. The X and Y axis values can be altered such that the shadow can be set to fall anywhere behind the widget area. "x-offset" - a positive number specifies the shadow will be on the right of the box, and a negative number will put the shadow on the left of the box. "y-offset" - a negative one means the shadow will be above the box, and a positive number means the shadow will be below the box. "Blur" - if the number is set to 0 then the shadow will be sharp. It will more blurred as the number goes higher, and the shadow will extend further away. "Color" - sets the colour of the shadow. If the colour is not set, the box shadows are drawn in the foreground colour. |
Hover Background | Set the background colour for the checkbox when the user moves the mouse over it. |
Last updated
