Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Overview

The Page Header component in noKodr is used to define the title of a section and to serve as a container for other components within the layout. It can be positioned at the top of the layout, offering a clear and identifiable section title.

  • Title Display: The Page Header displays the name or title of the section in the top left corner of the layout, providing a clear identifier for users.

  • Container for Components: It acts as a container where you can drag and drop additional components, allowing for a structured and organized layout.

For example, In a 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 control their behavior. It includes various sections explained below.

Basic

image-20240820-092241.png

Attribute Name

Description

Header

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

Sub Header

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

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.

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

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.

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.

UI Attributes:

image-20240820-092337.png

Attribute Group

Attribute Name

Description

UI

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 .

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.

Classes

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

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.

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, Read Only and Components Attributes:

image-20240820-092459.png

Attribute Group

Attribute Name

Description

Visibility

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.

Read Only

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.

Component

Component Label

It simply shows the name of the component.

Header and sub Header Source Type:

Merge Text

Merge text is a key feature of the noKodr application, allowing users to display field values on the UI. Depending on the data type, users can perform mathematical operations on these fields.

For example, if you want to display a calculated total price based on the quantity and unit price entered by the user on a sales order form, and you wish to dynamically showcase this on the UI without saving the record in the database, you can achieve this using the UI fields in noKodr.

After selecting merge text you can you can see several options such as:

Merge text popup.png

Attribute Name

Description

Source Type

In this option, you can select various sources from which you want to display values.

Value

The available options will change depending on the selected source type. For example, if you choose "Static" as the source, you can provide a fixed static value.

Merge Field Expression

The selected field from the source will be displayed in a merge format. For instance, the first name field from the contact model will appear as: {model:contact.FirstName}.

Message Body

In this option, You can add multiple values to form your final UI merge text.

For example, merge fields include {model:contact.FirstName},{model:contact.LastName} will eventually display the contact's first name and last name next to each other.

Available Sources

After clicking on the Gear Icon, you can select various sources to include fields or values, such as variables, other models, static values, etc.

Merger text sources.png

Source Type

Description

Static

Use this option to provide a fixed static value.

Field

Select the field from the chosen object in the model whose value you want to include.

Model

Choose the field from other models whose value you want to include.

Variable

Select from the variables created in the layout whose value you want to use.

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

You can also select fields from the current logged-in user in your organization to include in the merge.

Note: The User source refers to the currently logged-in user in your organization. This means that if you include the First Name field from the user, each time a different user logs in, they will see their own First Name displayed.

After selecting the source type, you need to choose the available options based on the selected type. For example, if you have selected "Model" as the source type, you will need to select one model from the available models.

Note: Only single record models are visible here and can be used in the merge text. Multi-record models are not supported here.

Merge text model.png

Once you select a model, the field options will become available. You can then choose the fields you want to include in your merge field expression and combine multiple fields to form your final expression in the message body.

Merge text final.png

Page Header Action:

image-20240823-074046.png

Attributes

Description

Label

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

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

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.

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:

image-20240813-133213.png

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

Conditional Visibility Type:

image-20240814-092607.png

Attributes Name

Description

Destination Type

Users can select the destination type where the visibility criteria must be applied.

Reference: Destination Type

Operator

Here, users can select different operators to add filters.

Reference: Filter Operator.

Source Type

Here, you can select the source type from various sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Destination Type

Destination Type

Description

Model

From this source, users can select a Model field to be displayed as the destination type.

Variable

Here, users can select the destination type from variables such as Record ID, Is Disabled, Is Read only, or Is Visible.

User

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

Record

It enables to choose record fields as destination type.

Device

It enables user to decide whether the action will be visible on the specific device type or not. Devices supported:

  1. Mobile

  2. Desktop

  3. Tablet

Conditional Disability Type:

image-20240814-093021.png

Attributes Name

Description

Destination Type

Users can select the destination type from various sources.

Reference: Destination Type

Operator

Here, users can select different operators to add filters.

Reference: Filter Operator.

Source Type

Here, you can select the source type from various sources.
Reference: Available Sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Conditional Read Only:

image-20240823-064414.png

Attribute Name

Description

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.

Add Condition & Group Condition

image (21)-20240822-182312.png

Condition

Description

Add Condition

  • The Add Condition feature allows users to define multiple criteria that must be met for a validation rule to trigger.

  • This feature is used to create complex logic by combining different conditions that Salesforce evaluates before allowing a record to be saved.

Add Group Condition

  • The Add Group Condition feature allows users to group multiple conditions together, creating complex logic that involves different sets of criteria.

  • This feature is particularly useful when combining conditions that should be evaluated as a unit (logical OR within a group) or when nesting conditions for more advanced logic.

Filter Operator:

Note: Before using the filter criteria, it's important to understand which filter operators are supported for each field type

Filters Attributes:

image-20240822-134925.png

Filter Operators

Operator

Supported Field Types

Description

Equal

Number, Currency, Date, Text, Boolean, Picklist

The equal operator is used to compare two values or expressions. It is used to compare numbers, strings, Boolean values, variables, objects, etc. The result is TRUE if the expressions are equal otherwise it’s FALSE

Contains

Text, Picklist

The contains operator returns TRUE if the value on the left contains the value on the right, and otherwise FALSE

Starts With

Text, Picklist

It returns TRUE if a string or number starts with the specified character otherwise it returns FALSE.

Ends With

Text, Picklist

It returns TRUE if a string or number ends with the specified character otherwise it returns FALSE

In

Text, Picklist

IN operator allows you to easily test if the expression matches any value in the list of values. Determines whether the value of an expression is equal to any of several values in a specified list.

Events:

  • Events are essentially the automation of invoking the component's actions.

  • Here, only onload event actions are available for this components.

image-20240822-091137.png

In the image below, you can select the created workflows.

image-20240822-084758.png

Note: "You need to create a workflow for selecting from this list.

For more information about Workflow check this out.

Reference: Workflow

Onload Event:

  • We have an onload event that runs when the component is loaded

For example, when a form is loaded, you can choose fields to be prepopulated by mapping field values using input mapping at the time the form component is loaded.

Input Mapping

image-20240822-091307.png

Input Mapping: Whenever an event is triggered and you want to pass data to destinations such as models, variables, or components, you can use input mapping to achieve that.

image-20240822-093156.png

  • No labels