Element Types Cheatsheet¶

Quick-reference for all screen meta data element types and option list sources.

Element types¶

type	UI rendered	Notes
`text-input`	Single-line text field
`text-area`	Multi-line text input
`numeric-input`	Numeric value input
`percent-input`	Percentage input	Stored as decimal or % depending on config
`date-input`	Date picker	Also: `local-date`
`select`	Single-select dropdown	Requires `optionList`
`multi-select`	Multi-value dropdown	Requires `optionList`
`type-ahead-select`	Select with search	Requires `optionList`
`type-ahead-multi-select`	Multi-select with search	Requires `optionList`
`repeatable`	Repeatable rows	Requires `repeatableElements`
`party`	Party search/lookup

Option list sources¶

optionList	Description	Extra config needed
`BUSINESS_CONSTANT`	Business constants file	`optionListParams.businessConstantType`
`API`	Client microservice endpoint	`optionListParams.formOptionsSourceUrl`
`ACTIVE_PRODUCTS`	Active products for this LOB	—
`UNDERWRITERS`	All underwriter users	—
`UNDERWRITING_ASSISTANTS`	All UW assistant users	—
`YES_NO`	Yes / No (Yes first)	—
`NO_YES`	No / Yes (No first)	—
`USER`	All Workbench users	—

Common modifierClass values¶

modifierClass	Effect
`non-editable`	Read-only field
`hide`	Hidden field (still submitted)

Common validator names¶

validator	Description
`dateAfter`	Date must be on or after specified date
`dateAfterControl`	Date must be on or after another field's date
`dateAfterAndNotOnControl`	Date must be strictly after another field's date
`dateBefore`	Date must be on or before specified date
`dateBeforeControl`	Date must be on or before another field's date
`dateBeforeWarning`	Warning (not error) if date is before specified date

Minimal element examples¶

Text input:

{ "key": "referenceNumber", "label": "Reference", "type": "text-input", "mandatory": true }

Select from business constant:

{ "key": "currency", "label": "Currency", "type": "select", "optionList": "BUSINESS_CONSTANT", "optionListParams": { "businessConstantType": "currency" } }

Date with validator:

{
  "key": "inceptionDate", "label": "Inception Date", "type": "date-input",
  "validators": [{ "validator": "dateAfter", "message": "Cannot be in the past", "value": "todaysDate" }]
}

Repeatable:

{
  "key": "retentions", "type": "repeatable",
  "repeatableConfig": { "title": "Retentions", "headerLabels": true },
  "repeatableElements": [
    { "key": "retentionValue", "label": "Value", "type": "numeric-input" },
    { "key": "retentionDescription", "label": "Description", "type": "text-input" }
  ]
}

For full documentation see Element Types.