Versions Compared

Version Old Version 17 New Version 18
Changes made by

Content Writers

Content Writers

Saved on

Key

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

...

Attributes are the options available for each component, allowing you to customize its appearance and control their behavior. It includes various sections explained below.

Basic:

...

For example, if there are 200 records for an object and you set the limit to 100, the List View will retrieve and display the first 100 records

.

Attribute Name

Description

Component Size

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

  • This feature allows for flexible customization, enabling users to resize components to fit their specific needs within the defined grid structure.

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.

Object

  • You are required to choose the object for displaying the List View.

  • Only standard and custom objects will be available for selection here.

Note: Metadata and System objects are excluded from the list

List View

  • You can choose a List View name from the available options.

  • Each object can have multiple List Views.

Note: You can select only one List View at a time.

List View Selectable ?Checkbox

This feature allows users to change the List View dynamically within the layout

.

  • When enabled, a drop-down icon appears next to the object selector in the layout.

    • Note: After enabling this checkbox, the "Is Object Selectable" checkbox will become available.

    Object Selectable ?

    Checkbox

    • This feature allows the end user to change the object at runtime.

    • When enabled, a drop-down icon appears next to the List View selector in layout.

    Table Actions

    • You can create multiple table actions for the List View. By default, two actions are visible in the top right corner.

    • These actions are used to perform operations such as creating, refreshing, and managing selected or unselected records

    Info

    Reference: Create Table Action Configuration

    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.

    Row Actions

    • Actions are performed at the record level for individual records.

    • These actions are primarily used to read, update, or delete a single record.

    • Each action is linked to a workflow that executes the specific operation. While default row actions include edit, delete, and view, you have the flexibility to create additional actions according to your needs.

    Info

    Reference: Create Row Action Configuration

    Column Actions

    • You can set the actions at the column level on the List View.

    • You can assign only one action to any column.

    • When you click record in the column action gets executed. Each action has a workflow that actually performs an operation.

    Note: When you assign a column action, the record in that column becomes a clickable link.

    Info

    Reference: Column Actions

    Layout For New

    You can choose an existing layout from the list.

    Same for Edit?

    • If the “Same for Edit” checkbox is enabled, the layout selected for “Layout For New” will also apply to Edit operations.

    • If disabled, you can choose a different layout for editing from the available options.

    Layout For Edit Checkbox

    You can select any layout from the drop-down for editing purposes.

    Offset

    You can set an offset for the query on the object.

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

    For example, if there are 200 records and you set the offset to 100, the List View will display records starting from the 101st record.

    Limit

    Set the number of records to query at once.

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

    Order By

    • You can specify the order in which fields are used to query and display records in the List View.

    • Records can be sorted in either ascending or descending order.

    Info

    Reference: Order By

    Filter Section Header

    		Users have the option to customize the header name that appears on the filter section on List View.

    Config

    ...

    :

    image-20240820-074123.pngImage Removed

    ...

    image-20240925-133746.pngImage Added

    Attribute Name

    Description

    Config

    Icon

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

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

    Note: The default icon size set as Small

    Show Index Checkbox

    Enabling this checkbox will display the index of records in the List View.

    Export supported Checkbox

    If you check that checkbox then the download icon will appear on the right side of the search box

    Note: Upon clicking the download icon on the List View, all the records can be exported in a CSV file

    UI State:

    ...

    Attribute Name

    Description

    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 here

    Info

    Reference: Conditional Visibility

    Base UI:

    image-20240925-133904.pngImage Added

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

    Note: Currently, we support Component Size 1 for Section. All other sizes will throw an error alert displaying Max allowed value is 1 .

    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.

    Classes

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

    Visibility and Components

    ...

    UI:

    image-20240925-134250.pngImage Added

    Component Label

    It simply shows the name of the component

    Attribute Name

    Description

    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 here

    Info

    Reference: Conditional Visibility

    Listview Selectable?

    Selecting this checkbox enables the list view selection dropdown option on the list view name.

    Offset

    You can set an offset for the query on the object.

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

    For example, if there are 200 records and you set the offset to 100, the List View will display records starting from the 101st record.

    Limit

    Set the number of records to query at once.

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

    For example, if there are 200 records for an object and you set the limit to 100, the List View will retrieve and display the first 100 records.

    Filter Section Header

    Users have the option to customize the header name that appears on the filter section on List View.

    Table and Row Actions

    ...

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

    ...