Versions Compared

Version Old Version 1 New Version Current
Changes made by

Content Writers

Content Writers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, In a in an application for managing project tasks, you might use the Page Header to title different sections such as " Upcoming Tasks , " "Completed Tasks," or " Task Overview ." By placing this title at the top of each section, users can easily navigate and understand the context of the content below, while also using the header area to organize related components.

...

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.

image-20240820-092241.pngImage Removed

...

Attribute Name

...

control their behavior. It includes various sections explained below.

Basic:

...

Note: The icon size is set to Medium by default.

Attribute Name

Description

Component Size

  • This allows users to modify the size of a specific component according to the grid size of layout.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example,
If the layout grid size is 3 then layout is divided into 3 sections then you can changes the components size between 1 to 3.

Layout Type

It is used to set the layout type in two ways as:

  1. Grid: The Grid Layout Type provides a grid-based layout system consisting of rows and columns. This layout simplifies the process of designing and structuring a layout, allowing for precise placement and alignment of components within the grid.

  2. 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.

Note: By default, this attribute is set to a value of Grid Layout Type.

Grid Size

It defines the width of the component in terms of grid columns, allowing users to control how much horizontal space the section occupies on the page.

Header

Name of the header which is displayed on the top left corner of the component.

Info

Reference: Header Source Type

Sub Header

Sub Header is displayed above the Header in the layout. The size of the Sub Header is smaller than the Header.

Info

Reference: Sub Header Source Type

No Body Checkbox

When the checkbox is marked as true, the "Add to Component" section of the Page Header will be hidden.

Icon

  • This field allows you to choose an icon from different categories like utility, action, custom and standard.

  • A search bar option is available to search for icons by name.

Info

Page Header Actions

  • An action represents a set of operations triggered by clicking an action button, such as Save or Cancel.

  • You can add multiple actions, each associated with a workflow that executes the desired operation.

Info

Reference: Page Header Action

Overflow After

This feature allows you to control the number of actions displayed. Setting the limit to 1 will show only one action, with additional actions appearing in a drop-down menu.

Base UI

...

:

...

UI

Attribute GroupAttribute Name

Description

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 `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.

Classes

It is used to apply SLDS classes to section, if needed.Layout

UI State:

...

Attribute Name

Description

Visibility 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.

Flow Type

  • Fit Content: This flow type automatically adjusts the size of the component to match the content it contains.

  • Equally Distributed: This flow type evenly divides the available space among components, ensuring that each component occupies an equal portion of the total area.

Grid Size

This feature allows you to display elements inside the tab. If you choose a grid size of 2, the elements will be arranged in two sections.

Visibility and Components Attributes:

image-20240820-092459.pngImage Removed

Attribute Group

Attribute Name

Description

Visibilitydetermines whether a component is visible on the layout. It offers the following visibility types:

  1. Always: The component will always be visible.

  2. 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 here.

Info

Reference: Conditional Visibility

Read Only Type

It specifies whether a component can be edited by users. It offers the following options:

  1. Never: The component will always be editable at any time.

  2. Always: The component will never be editable.

  3. 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 Visibility Type here.

Info

Reference: Conditional Read Only

UI:

...

Attribute Name

Description

No Body

When the checkbox is marked as true, the "Add to Component" section of the Page Header will be hidden.

Header and sub Header Source Type:

Page Header Action:

...

Attributes

Description

Label

A Label is the name shown to users and can come from various sources.

Info

Reference: Source Type

Name

Enter a unique the 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.

  1. Neutral

  2. Brand

  3. Outline Brand

  4. Success

  5. Destructive

Visibility Type

It determines whether a component is visible on the layout. It offers the following visibility types:

  1. Always: The component will always be visible.

  2. 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.

Component

Component Label

It simply shows the name of the component.

Events

Events available for any component is of onload type.

image-20240818-190902.pngImage Removed

Onload Events:

...

onload event occurs when the component has been loaded.

...

Here, only onload event actions are available for components.

...

  1. here

Info

Reference: Conditional Visibility

Disability Type

It determines whether a component is disable on the layout. It offers the following visibility types:

  1. Never: There is no disable option for this component

  2. Always: The component will always be visible.

  3. 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 here.

Info

Reference: Conditional Disability

Is Bulk Action Checkbox

If the bulk action checkbox is marked as true, it enables users to perform bulk actions on the selected items.

Minimum Record Count

The Minimum Record Count setting allows users to specify the minimum number of records required to perform a bulk action. This ensures that bulk actions are only triggered when a certain threshold of selected records is met

Label Source Type:

...

Attribute

Description

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

Choose the available cookie key whose value you want to include from your browser.

Local Storage Key

Select the available Local Storage Key whose value you want to include from your browser.

User

Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID.

Merge Field Expression

Merge Field Expression displays the value selected from the chosen value source.

Message Body

Inside the message body, user also can add the values manually.

Column actions

Include Page
Visibility and Disability
Visibility and Disability

Events

Include Page
Events (Common)
Events (Common)