Versions Compared

Key

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

...

The title defines the title of the form to be displayed in the web ui and in other locations.

This can be a static text or an i18n uri like $uri:i18n:myTitle for example.

description

The description is optional and describes the intention of the form.

This can be a static text or an i18n uri like $uri:i18n:myDescription for example.

icon

Each form can have an individual icon. This value must be a code name from the Google Material Icons as listed here: https://fonts.google.com/icons

...

Or it can be a constant selected from the Quasar color Colors palette. See here:

https://quasar.dev/style/color-palette/

For example you could use the color palette value constant “green” like this:
"color": "green"

...

"color": "red-8"

...

schema

The schema attribute defines a custom uri PIPEFORCE URI which is called in order to retrieve the Form schema for this form (see Form Schema & Widgets ).

For example, the attribute could look like this:

Code Block
"schema": "$uri:property:global/app/tld.domain.myapp/object/person/v1/schema"

Which returns could return a JSON schema like this:

Code Block
languagejson
{
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "title": "First Name",
      "description": "The first name of the person."
    },
    "lastName": {
      "type": "string",
      "title": "Last Name",
      "description": "The last name of the person."
    },
    "age": {
      "type": "number",      
      "title": "Age",
      "description": "The age of the person."
    },
    "gender": {
      "type": "string",
      "title": "Gender",
      "description": "The gender of the person.",
      "enum": [
        "male",
        "female",
        "neutral"
      ]
    },
    "birthDate": {
      "type": "string",
      "format": "date",
      "title": "Date of birth",
      "description": "The date of birth of the person."
    }
  }
}

...

  • action - Must be set to message.

  • text - Can contain a static text or an i18n key. If not given, the default text will be shown.
    See: TODO

  • icon - Must be a code name from the Google Material Icons as listed hereIcon. If not given, the default icon will be shown. See: https://fonts.google.com/icons . If not given, the default icon will be shown .

  • color - Defines the color of the icon. If not given, the default icon color will be shown.
    See Colors .

layout

TODO

type

TODO

Internationalization (i18n)

...