Configuration¶
Settings¶
where:
Argument | Description |
---|---|
Id |
Represents the unique identifier of the component. You can use this identifier to refer to this component when building your logic. |
Classes |
Allows applying custom CSS classes to the component. CSS classes define styles that can be used to control the appearance and formatting of the component. Refer to the Extensions topic for more information. |
Display |
Changes the visibility of the component in the application. The value of this property can be changed programmatically by using the Visibility Logic handler, refer to the Data Binding topic for more information. |
Label |
Allows you to specify the text that appears on the checkbox. The label should be clear and concise, describing the action the checkbox performs. The value of this property can be changed programmatically by using the Label Logic handler, refer to the Data Binding topic for more information. |
Checked |
When this parameter is enabled (checked), the checkbox will be selected by default when the user loads the form or interface containing it. This means that when the user views the checkbox, it will already be marked as "checked" or "ticked." This parameter is often used when you want to pre-select certain options or settings in a form or when you want to present a default choice to the user. However, users can typically interact with checkboxes to change their state, even if they are initially checked. The value of this property can be changed programmatically by using the Checked State Logic handler, refer to the Data Binding topic for more information. |
Disabled |
Disables the component in the application. The value of this property can be changed programmatically by using the the Disabled State Logic handler, refer to the Data Binding topic for more information. |
Tooltip text |
Provides additional information about the Checkbox that is displayed when a user hovers their cursor over the Checkbox. This feature is useful for offering context or brief explanations about the purpose of the Checkbox. The value of this property can be changed programmatically by using the Tooltip Text Logic handler, refer to the Data Binding topic for more information. |
Tooltip placement |
Determines where the tooltip appears in relation to the Checkbox. You can choose from various options, such as Top , Right , Bottom , and Left . This setting ensures that the tooltip is positioned in a way that does not obstruct the Checkbox' content or other user interface elements. |
General¶
where:
Argument | Description |
---|---|
Position |
Determines the positioning behavior of the component within its parent container. Available options are:default - This option uses the default positioning behavior, which usually means that the component will follow the normal document flow and be positioned based on its place in the layout. When this option is selected, Position settings do not affect the position of the element.relative - Allows you to position the component relative to its normal position(default position) within the document flow. You can then use properties like top, bottom, left, and right to offset the component from its original position. These properties are available in the Position section of the component configuration.absolute - Positions the component absolutely within its closest positioned ancestor (a parent element with a position value other than fixed ). You can use properties like top, bottom, left, and right to specify the exact position. These properties are available in the Position section of the componentfixed - Positions the component relative to the viewport. It remains fixed even when the user scrolls the page. This is commonly used for elements that you want to stay in a specific position while the rest of the content scrolls.sticky - Makes the component behave like "relative" within its parent container until it reaches a specific scroll position. Then, it becomes "fixed" and stays in that position until the user scrolls past it. |
Z Index |
Determines the vertical stacking order of the component relative to other components on the same screen. Components with higher Z Index values will appear above components with lower values, effectively controlling their overlapping arrangement. This allows you to control the visual hierarchy of components, ensuring that certain elements appear in front of or behind others, providing flexibility in designing the user interface of your application. |
Cursor |
Identifies the cursor type when the mouse is hovered over the component. Refer to the Mozilla documentation to see what each cursor looks like. |
Color |
Sets the color for the Checkbox content. |
Flex¶
With Flex settings, you can control how components within a container are positioned, aligned, and distributed.
Icon |
Description |
---|---|
Default alignment of the component. |
|
Aligns the component to the start of its container. |
|
Aligns the component to the end of its container. |
|
Stretches to occupy all available space. |
|
Centers the component within its container. |
Dimension¶
where:
Argument | Description |
---|---|
Width |
Controls the width of the component. Available measurement units are: px , % , vw . |
Height |
Controls the height of the component. Available measurement units are: px , % , vh . |
Min Width |
Prevents the component from changing its width below the specified baseline value. Available measurement units are: px , % , vw . |
Min Height |
Prevents the component from changing its height below the specified baseline value. Available measurement units are: px , % , vh . |
Max Width |
Prevents the component from changing its width above the specified baseline value. Available measurement units are: px , % , vw . |
Max Height |
Prevents the component from changing its height above the specified baseline value. Available measurement units are: px , % , vh . |
Margin
Both positive and negative values can be utilized within the Margin settings.
where:
Argument | Description |
---|---|
Top |
Defines the space between the top edge of the component and the element above it. In case there is no element above the component, then the top border of the parent container will be used for margin spacing. Increasing the top margin value will create additional space above the component. Available measurement units are: px , % , vh . |
Right |
Controls the space between the right edge of the component and the element to its right. If there is no element to the right of the component, then the right border of the parent container will be used for margin spacing. Adjusting the right margin value increases or decreases the space on the right side of the component. Available measurement units are: px , % , vw . |
Bottom |
Determines the space between the bottom edge of the component and the element below it. In case there is no element below the component, then the bottom border of the parent container will be used for margin spacing. Increasing the bottom margin value adds space below the component. Available measurement units are: px , % , vh . |
Left |
Sets the space between the left edge of the component and the element to its left. If there is no element to the left of the component, then the left border of the parent container will be used for margin spacing. Modifying the left margin value changes the space on the left side of the component. Available measurement units are: px , % , vw . |
Position¶
where:
Argument | Description |
---|---|
Top |
Defines the vertical position of the component relative to its containing element. Available measurement units are: px , % , vh . |
Right |
Governs the horizontal positioning of the component relative to the left edge of its parent container. Available measurement units are: px , % , vw . |
Left |
Defines the horizontal positioning of the component relative to the right edge of its parent container. Available measurement units are: px , % , vw . |
Bottom |
Controls the vertical position of the component from the bottom edge of its containing element. Available measurement units are: px , % , vh . |