Function generateFormElementsConditionallyShown

Given form elements and submission data, evaluate which elements are currently shown and whether submission is enabled. The function also takes an optional errorCallback for handling errors caught during the evaluation.

Example

const { formElementsConditionallyShown, isSubmissionEnabled } =
  conditionalLogicService.generateFormElementsConditionallyShown({
    submission: {
      radio: ['hide'],
      text: 'hidden text',
    },
    formElements: [
      {
        name: 'radio',
        label: 'Radio',
        type: 'radio',
        required: false,
        id: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',
        conditionallyShow: false,
        options: [
          {
            id: '9a44e15a-5929-419d-825e-b3dc0a29591f',
            label: 'Show',
            value: 'show',
          },
          {
            id: 'd776ed42-072c-4bf8-9879-874b2bef85d3',
            label: 'Hide',
            value: 'Hide',
          },
        ],
        readOnly: false,
        isDataLookup: false,
        isElementLookup: false,
        buttons: false,
        optionsType: 'CUSTOM',
        conditionallyShowOptions: false,
      },
      {
        name: 'text',
        label: 'Text',
        type: 'text',
        required: false,
        id: '8fbddb41-348d-494c-904b-56a2c4361f13',
        requiresAllConditionallyShowPredicates: false,
        conditionallyShow: true,
        conditionallyShowPredicates: [
          {
            elementId: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',
            optionIds: ['9a44e15a-5929-419d-825e-b3dc0a29591f'],
            type: 'OPTIONS',
          },
        ],
        readOnly: false,
        isDataLookup: false,
        isElementLookup: false,
      },
    ],
    errorCallback: (error) => {
      //do something with the error here
      console.error(error)
    },
  })
Copy

The above example returns an object like below

{
  "formElementsConditionallyShown": {
    "radio": {
      "isHidden": false,
      "type": "formElement"
    },
    "text": {
      "isHidden": true,
      "type": "formElement"
    }
  },
  "isSubmissionEnabled": true
}
Copy