Skip to end of metadata
Go to start of metadata

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

Compare with Current View Version History

« Previous Version 8 Next »

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 which the user can arrange the fields. The Layout options are

    • Stacked: In a stacked layout, the field placeholder is under the field label in a vertical manner with a small margin around the label and placeholder.

    • Horizontal: In a horizontal layout, the field placeholder is in front of the field label in a horizontal manner with a small margin around the label and placeholder.

    • Single Column: A Single Column layout is the same as a horizontal layout the only difference is the 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 

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

  • *Hide Space:   

  • *URL to create a field as a link:  

  • *Is Clickable:

  • Inline Edit: This checkbox allows the user to edit the field directly in view mode 

  • Debounce Time in seconds: Debounce Time is the time between the two actions. For example, if you click on the save button the time taken to complete the save action is debounce time

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

  • Read only Type:

    • Never: The field cannot be read-only 

    • Always: The field is always read-only 

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

  • Disability Type:

    • Never: The field cannot be disabled

    • Always: The field can be disabled

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

  • No labels