...
The Section component serves as a container that groups content, such as Forms, Tables, Badges, and other components. It provides a structured way to organize and display information within your application.
...
Attributes
Attributes are the options available for each component, allowing you to customize its appearance and functionality. They help you tailor the look and behavior of your components to fit your needs.
Basic
Attribute | Description |
|---|
Header | It is a short description that defines the purpose or content of the Section to the user. The header is displayed at the top left of the Section, providing a clear label for the grouped content. You can explore more about Header attribute here.
|
No Header | If the "No Header" checkbox is selected, the header will not be displayed on the Section. This option allows user for a cleaner look when a header is not needed.
|
Is Collapsible | This checkbox allows users to make sections of the application interface collapsible, enhancing the overall user experience. When enabled, users can collapse or expand sections by interacting with the section header.
|
Actions | This allows users to add multiple actions to a section, each represented as a button. It enables users to quickly perform specific actions or invoke workflows directly from the section header. You can explore more about Actions attribute here.
| Info |
|---|
Note: Display Limit: Only two action buttons will be displayed directly on the section header. Dropdown for Additional Actions: If more than two actions are added, the remaining actions will automatically be displayed in a dropdown menu.
|
|
Overflow After | It is used to manage the display of actions in a list format within a section header. | Info |
|---|
Note: By default, this attribute is set to a value of 3, meaning that up to three actions will be directly visible in the section header. |
| Panel |
|---|
| panelIconId | 1f5e8 |
|---|
| panelIcon | :speech_left: |
|---|
| panelIconText | 🗨️ |
|---|
| bgColor | #F4F5F7 |
|---|
| For Example: If you have three actions, all will be displayed in the section header. If you add a fourth action, it will appear in the drop-down list, along with any subsequent actions. |
|
Show Border | It is used to simply add border surrounding the section. | Info |
|---|
Note: Currently, we support only black borders. |
|
Component Size | This allows users to modify the size of a section within the layout according to the grid size. This feature allows for flexible customization, enabling users to resize components to fit their specific needs within the defined grid structure.
| Info |
|---|
Note: Currently, we support Component Size 1 for Section. All other sizes will throw an error alert displaying Max allowed value is 1 . |
|
Padding Location | "Padding Location" typically refers to the configuration of spacing around elements |
Padding Size | "Padding Size" refers to the amount of space added inside an element, between the element's content and its border or edge. |
Margin Location | "Margin Location" refers to the spacing around the outside edge of an element |
Margin Size | "Margin Size" refers to the amount of space around the outside edges of an element, |
Style | It is used to apply custom styles to section, such as color, font, size, and more. It allows you to define the appearance of a component by specifying CSS properties directly within the attribute. You can explore more about Styles attribute here.
|
Classes | |
Layout Type | It is used to set the layout type in two ways as: Grid: The Grid Layout Type provides a grid-based layout system consisting of rows and columns. This layout type simplifies the process of designing and structuring a layout, allowing for precise placement and alignment of components within the grid. Flow: The Flow Layout Type is used for positioning and formatting components within a layout. This layout type allows components to be positioned in relation to each other.
| Info |
|---|
Note: By default, this attribute is set to a value of Grid Layout Type. |
You can explore more about Layout Type attribute here.
|
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types: Always: The component will always be visible. Conditional: The component's visibility is determined based on specific criteria, which can make it either visible or hidden as needed.
You can explore more about Visibility Type attribute here.
|
Read Only Type | It specifies whether a component can be edited by users. It offers the following options: Never: The component will always be editable at any time. Always: The component will never be editable. Conditional: The component's editability is determined based on specific criteria, which can make it either editable or read only as needed.
You can explore more about ReadOnly attribute here.
|
Component Label | It simply shows the name of the component. You can explore more about Component Label attribute here. |
...
Label Source Type Attribute | Description |
|---|
Static | It includes only records from the manually input value. |
Model (Salesforce Object) | From this source, users can select a Model (Salesforce Object) field to be displayed as the label name. |
Variable | Here, users can select the label name from variables such as Record ID, Is Disabled, Is Read only, or Is Visible. |
cookie key | By using the Cookie Key, the result is fetched by the value that has been added under the Cookie Key. But, have to make sure that the value that we are adding is from the Cookie Key value. |
Local Storage Key | By using the Local Storage Key, the result is fetched by the value that has been added under the Local Storage Key. But, have to make sure that the value that we are adding is from the Local storage value. |
User | Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID. |
Actions:
...
Header Action Attributes | Description |
|---|
Label | A Label is the name shown to users and can come from various sources. |
Name | Enter a unique API name for your action. |
Icon | This option lets you choose from various icons to add to the action button. |
Variant | This feature allows users to change the appearance of the action button. You can explore more about variants here. |
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types: Never: There component will never be visible. Always: The component will always be visible. Conditional: The component's visibility is determined based on specific criteria, which can make it either visible or hidden as needed.
You can explore more about Conditional Visibility Type attribute here.
|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types: Never: There is no disable option for this component Always: The component will always be disabled. Conditional: The component's visibility is determined based on specific criteria, which can make it either visible or hidden as needed.
You can explore more about Conditional Disability Type attribute here.
|
Variants:
Variant | Description |
|---|
Neutral | Neutral is the default variant of the Action which is displayed in white color. |
Brand | Brand variant is a blue color. |
Outline-brand | Outline-brand is like the brand variant, but the color is used for the label and border only, not the whole Action color. |
Destructive | Destructive variant is in a red color. | Info |
|---|
Note: It is usually used to group buttons which depict actions which warn the user. |
|
Success | Success variant is in a green color. | Info |
|---|
Note: It is usually used to group buttons which depict successful action. |
|
...