Field

1. Overview

The field type is an atomic component. That is, nothing can be placed inside it. It renders a Field from the current record, specified by the field key.

2. Object Properties

The table provides a summary of the object properties associated with the field:

Property	Type	Requirement	Description
`type`	`string`	Mandatory	Always set to `field`.
`field`	`string`	Mandatory	Refers to the internal ID of the Field to render (e.g., `"status"`).
`label`	`string`	Optional	Overrides the Field's name. If set, it displays as the label.
`options`	`object`	Optional	Provides additional customisation options.
`readonly`	`boolean`	Optional	When `true`, displays the Field's value without an input Field.
`mandatory`	`boolean`	Optional	Sets the default mandatory state as `true` or `false`, overriding the Field`mandatory` setting.
`noValueText`	`string`	Optional	Text to display when the Field value is blank. If omitted, defaults to `No LABEL`(e.g. `No due date` for a Field with the label “Due date”).
`placeholder`	`string`	Optional	If set, the input Field's placeholder is used, overriding the Field's placeholder. If omitted, the Field's placeholder is used.
`description`	`string`	Optional	If set, the input Field's description is used, overriding the Field's description. If omitted, the Field's description is used.
`errorText`	`string`	Optional	Text displayed when the Field has an error (e.g., mandatory and blank).
`disableAdd`	`boolean`	Optional	If `true`, hides the `+` button for adding an entry via a modal (for `select`/`multi-select` Fields).
`labelOptions`	`object`	Optional	Customisation options for label rendering.
`hide`	`boolean`	Optional	When `true`, omits to display the label.
`orientation`	`string`	Optional	Specifies label orientation as `top` or `bottom`; defaults to `top` if not set.
`icon`	`string`	Optional	If set, it renders an icon (e.g., `fa-duotone fa-house`) beside the label.
`color`	`string`	Optional	If set, it alters the label and icon colour. The options are `primary`, `secondary`, `default`((the normal gray color)), and all hex codes.
`weight`	`string/number`	Optional	Defines valid `font weight` (CSS value) for the label.
`iconColor`	`string`	Optional	Modifies the colour of the label's icon.

3. Sample Configuration

This example renders a Field onto the Entry Layouts using all of the Field's settings.

{
"type": "field",
"field": "name"
}

This example renders a Field onto the Entry Layouts using many available settings.

{
"type": "field",
"field": "name",
"label": "Name",
"options": {
      "mandatory": true, 
      "readonly": true,
      "noValueText": "No name has been set",
      "placeholder": "Type a name..."
      "description": "Type into this field to set the name of this entry",
      "errorText": "Please set a name",
      "labelOptions": {
            "orientation": "bottom",
            "icon": "fa-duotone fa-house"  
         }
     }
}

📌 Need Help?

If you require assistance or encounter any issues, please don't hesitate to contact us for further support.