Organisation - smbc-digital/form-builder GitHub Wiki

Refer to Stockport Design System for styling information and reference images

DSL properties

Property	Type	Required	Default Value	Description
QuestionId	string	✔️	❌	Unique question id allowed charatcers are [a-zA-Z] only
OrganisationProvider	enum	✔️	❌	Organisation provider used for organisation data lookup
Label	string	✔️	❌	Label associated with the search term
SelectLabel	string	✔️	❌	Label associated with the select dropdown
Hint	string	❌	❌	Hint which appears above the postcode input
SelectHint	string	❌	❌	Hint which appears above the select input
Optional	bool	❌	false
CustomValidationMessage	string	❌	❌	Set a custom validation message for when user does not enter a organisation)
SelectCustomValidationMessage	string	❌	❌	Set a custom validation message for when user does not select an organisation from the dropdown
TargetMapping	string	❌	❌	Used for custom object mapping when creating submit data
StrongLabel	bool	❌	false	Labels associated to inputs are strong
MaxLength	int	❌	200
LabelAsH1	bool	❌	false	Display the inputs label as a h1 and not a label (if this is set to true, HideTitle in the Page properties should also be set to true)
SummaryLabel	string	❌	❌	Change the label associated with this input on the summary

Organisation examples

DS Json for organisation:

       {
      "Title": "Enter your organisation",
      "PageSlug": "organisation-search",
      "HideTitle": true,
      "Elements": [
        {
          "Type": "Organisation",
          "Properties": {
            "LabelAsH1": true,
            "StrongLabel": true,
            "QuestionId": "organisation",
            "Label": "Enter the organisation",
            "SelectLabel": "Select the organisation",
            "Hint": "This is an additional hint",
            "OrganisationProvider": "Fake"
          }
        },
        {
          "Type": "Button",
          "Properties": {
            "ButtonId": "nextStep",
            "Text": "Continue"
          }
        }
      ]
    },

All possible properties example:

    {
      "Title": "Enter your organisation",
      "PageSlug": "organisation-search",
      "HideTitle": true,
      "Elements": [
        {
          "Type": "Organisation",
          "Properties": {
            "LabelAsH1": true,
            "StrongLabel": true,
            "QuestionId": "organisation",
            "Label": "Enter the organisation",
            "SelectLabel": "Select the organisation",
            "Hint": "This is an additional hint",
            "SelectHint": "This is an additional hint",
            "OrganisationProvider": "Fake",
            "Optional": true,
            "CustomValidationMessage": "Custom org validation message",
            "SelectCustomValidationMessage": "Custom org select validation message",
            "TargetMapping": "customer.org"
          }
        },
        {
          "Type": "Button",
          "Properties": {
            "ButtonId": "nextStep",
            "Text": "Continue"
          }
        }
      ]
    }