Versions Compared

Key

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

Overview

...

  • Field can be defined as the column represents in a relational database, it can store values that are required for a particular object in a record.

  • Fields can be created in different data types.

Configuration of a Field component:

...

  • Name: Name is a combination of an instance prefix and a label, it is a unique identifier in an instance

For example, if your instance prefix is ‘Test’ and a component label is a ‘Text’ then the Name will be test_text

  • Label: A label is a single-word description of a component that will be used to display on UI on layout designer and list views. Users can update the field label.

  • Placeholder: A placeholder is a text, located inside a field. It is an additional hint, description, or example of the information required for the field. The Placeholder text is editable(Refer to Fig. 1 number 1)

  • Layout: It is a design through The Field is a generic component using which you can accept values in different formats and data types

  • e.g. number, phone, email, text, etc

  • It can be bound with the model Field and variable

  • If you want to accept/display data to the user without an object you can use the Field component

Attributes

Label

  • The label is a short description of the field that will be displayed before the data input/output

Placeholder

  • A placeholder is a short text, located inside the input data field

...

Layout

  • It is a design using which the user can arrange the fields.

  • The Layout options arecomes in 5 different forms:

  • Stacked: In a stacked layout, the input/output field

    placeholder

    is under the field label

    in a vertical manner

    with a small margin around the label

    and placeholder.

    , and the input/output field

  • Horizontal: In a horizontal layout, the input/output field

    placeholder

    is in front of the field label

    in a horizontal manner

    with a small margin around the label

    and placeholder.

    , and the input/output field

  • Single Column: A Single Column layout is the same as a horizontal layout the only difference is the input/output field

    placeholder

    size is greater than the field label in a layout

    .

  • *

    No Label: In the No Label layout, the label name is not

    visible 

    visible only the input/output field is present in the layout

  • *Hide Space:   

  • Compact: Compact layout is the same as a stacked layout, the difference is there is no margin around the label and

    placeholder

...

  • *the input/output field

...

...

*Is Clickable:

...

  • This feature is used to make a field a hyperlink field

  • This value will serve as a hyperlink text

Inline Edit

  • The inline edit feature allows us to edit the record without pressing the edit button

Debounce Time in seconds

...

  • Debounce Time is the time between taken to complete the two actions. For example, if

  • e.g. When you click on the save button, the time taken it takes to complete the save action is debounce debouncing time

Validations

...

*Value Destination Type:  

...

*Value Destination Variable:

...

*Value Destination Model:

...

*Component Size:

...

Margin Location: Defines the position of the margin for a field. Users can apply the margin for around, top, left, bottom, right, horizontal and vertical location

  • Around: Margin

...

Margin Size: The user can set the margin size as xxx-small, xx-small, x-small, small, medium, large, x-large, xx-large

...

*Style: Style describes how fields should be rendered in preview mode. Users need to create one cdn link from the CSS tab on the layout designer page to use the style

...

*Classes: Classes are used to apply unique styling and formatting to the fields in preview mode. Users need to create one cdn link from the CSS tab on the layout designer page for using classes

...

Visibility Type: Specifies whether the field is visible or not

  • Always: The field is always visible

  • Conditional: Visibility of a field depends on the given condition or criteria

...

Required Type: Specifies whether the field is required or not

  • Never: The field is not required

  • Always: It must be a mandatory field

  • Conditional: Depending on the required criteria, the field can be set as required or not 

...

Required Error Message: The user can enter a custom error message for the required field 

...

Show Success Message: Using this checkbox, the user can show a success message  

...

Success Message: The user can enter a success message when the show success message checkbox is true

...

Show Error Message: Using this checkbox, the user can show an error message on the layout

...

Error Message: The user can enter an error message when the show error message checkbox is true

...

  1. Required Type: Ensures that a specific type of input is required.

  2. Required Error Message: Specifies the error message to be displayed when the required type is not provided.

  3. Minimum Length: Specifies the minimum length of input required.

  4. Min Length Error Message: Specifies the error message to be displayed when the input length is less than the minimum required length.

  5. Maximum Length: Specifies the maximum length of input allowed.

  6. Max Length Error Message: Specifies the error message to be displayed when the input length exceeds the maximum allowed length.

  7. Pattern: Specifies a pattern or format that the input must adhere to.

  8. Pattern Error Message: Specifies the error message to be displayed when the input does not match the specified pattern.

Read-only:

Never: The field cannot be read-

...

only

...

 Always: The field

...

will be always read-

...

only

...

 Conditional: Depending on the read-only criteria, the field can be set as read-only or

...

not

 

Disable:

Never: The field cannot be disabled

Always: The field

...

will be always disabled

...

 Conditional: Depending on the disability criteria, the field can be set as disabled or not