Fields schema

The fields schema is the one that describes how the UI of your plugin should look like. It has access to a variety of UI fields which it can show in the UI as the form data for the users to put their input. Each Field schema creates a UI component in the form that you want to build.

Properties

Detailed information on how to create each of the supported UI components can be found here. Interpolations can be used in these UI components.

Different types of UI components can be created using the different values in the type property.

Types of fields

Boolean

If you want to have a checkbox then you should use the boolean as the type. The value retrieved from this kind of UI component is always going to be boolean

{
    fields: [
        {
            key: "private",
            label: "Private",
            type: "boolean",
            helpText:
                "Indicate whether these notes needs to be Private or Public ( Visible to everyone on the portal ).",
        },
    ]
}

Text

If you want to create a multiline Text-box component, then the type property should be set to text.

{
    fields: [
        {
            key: "notes",
            label: "Notes",
            type: "text",
            helpText: "The notes that need to be added to the Ticket.",
        },
    ]
}

Dict

If you want to show dynamic key value pairs in the UI then dict component will come in handy. It is used to get the object. It creates a dynamic list of two input fields in a line where the first one is considered as a key and the second one is the value. Both key and value are of type strings.

      {
    fields: [{
        key: "custom_fields",
        label: "Custom fields",
        type: "dict",
        helpText: "Provide any aditional customs fields as **key/value** pairs",
    }]
}

Dynamic fields

Certain fields may require data fetched from outside the system. Dynamic fields allow you to show external data a form and use the selected data elsewhere in the flow.

To create a dynamic field, the dynamic field should follow a specific structure: resource_id.identifier.label