Checkbox
This post is referring to Vahana 2 (beta version). To check the document for production, please go to vDesigner-v1.0
Checkboxes are used for multiple choices, but not for mutually exclusive choices. Each checkbox works independently from other checkboxes in the list. Selecting a checkbox does not affect any other selection.
For example:-For taking the user’s hobbies as an input, you can provide multiple hobbies with the check boxes. The user can click more than one checkbox to select multiple hobbies.

Usage
When to use | When not to use |
Used for selecting multiple values from a specific set of options. | If you use only one checkbox, it is the same as using Switch to toggle between two states. The difference is that Switch will trigger the state change directly, but the check box just marks the state as changed and this needs to be submitted. |
Check Box Configuration
The check box element include the following configurable properties:
- UI Configuration
- Event Configuration
UI Configuration
For the checkbox element, UI configuration include the followings:
Tab | Property Name | Description | Mandatory | New Default Value | Visibility Rules |
Basic | Reference Name | Specifies a unique name of the element. At the application level, an element is identified and managed by the reference name. | Yes | CheckBox 1 | |
Basic | Caption | Denotes the title of the element. | No | Checkbox | |
Basic | Max in Row | Allows the user to define the maximum number of checkboxes to be displayed in a row | No | 1 | |
Basic | Input Source | This property allows you to configure the source location for the following purposes: –> Fetch data from the source and the display it on the element. –> Store data in the source. You can click one of the following tabs to configure the input source: 1) Data Store:- If you select this tab, the Input Value box appears. In the Input Value box, select an entity based array type JSON object. After you select an array type JSON object, the application will access the object and then perform one of the following functions: –> Fetches data from the object and displays it in the element –> Stores data in the object 2) Enumeration:- If you select this tab, a Select Master list appears. Click the Select Master list, and then it displays a list of enum objects from the Data Modeler. In the list, select an enum object. After you select an enum object, the application will perform one of the following functions: –> Fetch data from the enum and then display it in the element –> Store data in the enum Note:- To use the enum object, you need to define “enum†in the Data Modeler. | Yes | Data Store | |
Basic | Input Value | Click in this box and then select an array type object. After you select the object, the application will perform one of the following functions: –> Fetch data from the object and then display it in the element. –> Store data in the object. | Yes | {{fx}} | When Input Source = Data Store |
Basic | Wrap | Allows you to wrap the element around the content | No | unmarked | |
Basic | Visible | Allows you to define the default visibility of the UI element. | No | marked | |
Basic | Enable | Allows the user to enable/disable an element. You can decide whether the element needs to be clickable and usable. | No | unmarked | |
Basic | Mandatory | Allows you to configure the element as a mandatory element. | No | unmarked | |
Basic | Message on Failure | This property becomes visible when you select Yes under Mandatory. In the Message on Failure box, enter the error message that the application will display if the user does not perform the function on the element. | No | Required | when mandatory = checked |
Basic | Default Value | This property allows you to define the default value of an element. To define the default value: –> Click in this box, and it displays the list of the pre-define functions, attributes, and element IDs. –> In the list, select an attribute from which the application will fetch the default value and then display it in the element. | |||
Basic | Parent Element ID | In this list, you can select the ID of an element. Based on the selected ID of an element, the current element will display the list of values. To select the element ID: i. Click in this box, and it displays the list of the pre-defined functions, attributes, and element IDs. ii. In the list, select an element’s ID. | |||
UI Properties | Styles | Allows you to select a specific style for the element from the list of pre-defined styles. The vDesigner module offers pre-defined styles that you can apply to the element. These styles are: –> Primary –> Success –> Secondary | No | Primary | |
UI Properties- Background | Color | Select the color of the caption | No | Theme Variable (Neutral) | |
UI Properties- Background | Opacity | Opacity is the degree to which content behind an element is hidden, and is the opposite of transparency. | Yes | 100% | |
UI Properties- Background | Select Color | Allows a user to define the background color of the options after they are selected | No | Transparent | |
UI Properties- Background | Opacity | Opacity is the degree to which content behind an element is hidden, and is the opposite of transparency. | Yes | 100% | |
UI Properties- Background | Unselect Color | Allows a user to define the background color of the options after they are unselected | No | Transparent | |
UI Properties- Background | Opacity | Opacity is the degree to which content behind an element is hidden, and is the opposite of transparency. | Yes | 100% | |
UI Properties- Alignment & Spacing | Margin | Allows you to desirably define margin around each side of the element. It provides four different boxes to define the margin outside the right, left, top, and bottom border of the element. | No | Theme Variable (Margin) | |
UI Properties- Alignment & Spacing | Element Alignment | Click this list to align the element as follows:- –> Right –> Top –> Bottom –> Top Right –> Top Left –> Bottom Right –> Bottom Left –> Center | No | Left Top | |
UI Properties- Caption | Font | Select the Font of the caption | No | Theme Variable (Font Family) | |
UI Properties- Caption | Size | Select the Font size of the caption | No | 12 | |
UI Properties- Caption | Color | Select the color of the caption | No | Theme Variable (Caption) | |
UI Properties- Caption | Bold | Select the thickness of character of the caption | No | 4 | |
UI Properties- Shape & Decoration | Type | Under the Shape and Decoration section, this property has the two following options: Autofill:- If you select this option, you cannot change the element’s dimensions. When you drag the element to the canvas, this option is selected by default. If you select Auto Fill, vDesigner places the element with the default dimensions. Manual:- If you select this option, you can change the dimensions of the element. | |||
UI Properties- Shape & Decoration | Width Value | Enter the width of the element in the percentage unit or pixel unit. | No | 100% | |
UI Properties- Shape & Decoration | Height Value | Enter the height of the element in the pixel unit. | No | Set as ___ & Disable | |
UI Properties- Shape & Decoration | X | Allows you to move the element along the X-axis; when the value increases, the element moves from left to right. | No | Show & Disable | |
UI Properties- Shape & Decoration | Y | Allows you to move the element along the Y-axis; when the value increases, the element moves from top to bottom. | No | Show & Disable | |
UI Properties- Shape & Decoration | Border Color | Allows the user to define the color of the border of the checkbox | No | Theme Variable (Border Color) | |
UI Properties- Shape & Decoration | Opacity | Opacity is the degree to which content behind an element is hidden, and is the opposite of transparency | Yes | 100% | |
UI Properties- Shape & Decoration | Select Color | Allows a user to define the background color of a checkbox, after a checkbox is selected by the application user | No | Theme Variable (Primary) | |
UI Properties- Shape & Decoration | Opacity | Opacity is the degree to which content behind an element is hidden, and is the opposite of transparency | Yes | 100% | |
UI Properties- Shape & Decoration | Unselect Color | Allows a user to define the background color of a checkbox, after a checkbox is unselected by the application user | No | #161616 | |
UI Properties- Shape & Decoration | Opacity | Opacity is the degree to which content behind an element is hidden, and is the opposite of transparency | Yes | 100% | |
UI Properties – Option | Font | Select the Font of the hint text | No | Theme Variable (Font Family) | |
UI Properties-Option | Size | Select the Font size of the hint text | No | 12 | |
UI Properties-Option | Color | Select the color of the Option text | No | Theme Variable (Caption) | |
UI Properties-Option | Bold | Select the thickness of character of the Option text | No | 4 | |
UI Properties-Option | Hide Text | Allows the user to configure the option text as follows: Yes:- The option text becomes unavailable. No:- The option text becomes available. | No | unmarked | |
Data | Entity Path | This property allows you to map an attribute to the element. You define the JSON based attributes in the entity in the Data Modeler module. To define the entity path: –> Click in the Entity Path box, and a list expands. –> The list displays several attributes from the entity. –> In the list, select an attribute to map it to the element. After the user performs the function on the element, the application can perform the following functions: a. Fetches data from the attribute and then displays it in the element. b. Stores data in the attribute. | No | EntityName. | |
Security Properties | Regex | Allows you to define the Regex (Regular Expression) based condition that replaces the real values from a specific character. | No | ||
Security Properties-Basic | Data Masking | This property allows you to mask the data. After you click the Data Masking check box, the following boxes appear: 1. Masking Type 2. N 3. Masking Symbol | No | Clear Check box | |
Security Properties-Basic | Masking Type | Click this list to select one of the following options: 1. From Start This option masks a specific number of characters (for example:- **ample123) from the left. 2. From End This option masks a specific number of characters (for example:- Example1**) from the right. 3. From Start & End This option masks a specific number of characters (for example:- **ample***) from the left and right of the string. 4. Except Start This option masks all characters except a specific number of characters (for example:- Ex********) from the left. 5. Except End This option masks all characters except a specific number of characters (for example:- ********23) from the right. 6. Except Start & End This option masks all characters except a specific number of characters (for example:- Ex*****123) from the left and right. 7. All Alphabets This option masks all alphabets (for example:- *******123) in the string. 8. All Numbers This option masks all numbers (for example:- Example***) in the string. 9. All This option masks all characters in the string. | No | From Start | If Data Masking check box is selected |
Security Properties-Basic | N | This box comes into view after you click the Data Masking check box. In this box, enter a numeric value that specifies the number of characters that are masked from right or left in the string. For example:- If you select From Start in the Masking Type list and then enter 4 in the N box, the data masking property masks four characters from the left. If you select From End in the Masking Type list and then enter 4 in the N box, the data masking property masks four characters from the right. | No | If Data Masking check box is selected | |
Security Properties-Basic | M | This box comes into view after you select From Start & End in the Masking Type list. In the M box, enter a numeric value that specifies the number of characters that the Data Masking feature masks from the right of the string. For example:- If you enter 4 in the M box, the data masking property masks four characters from the right. | Yes | If Masking Type = From Start & End | |
Security Properties-Basic | Masking Symbol | Click this list and then select one of the following characters that you can use as a masking symbol or character: 1. * 2. & 3. % 4. $ 5. # 6. @ 7. x 8. – 9. + | No | If Data Masking check box is selected |
Event Configuration
On the “Check Box” element, you can configure the following event:
- onSelect
Was this article helpful?
YesNo