Validate

The Validate action is used to validate a users input, usually before information is inserted into a database using a request. It is used in conjunction with the required and validate fields on input blocks. If the validation fails, the Validate action will fail, and this will stop the execution of actions that are defined after it.

The first time a Validate action is called, validation errors and warnings are shown to the user. The Reset action resets the validation status and the page state. The ResetValidation action resets only the validation status.

The Validate action blockIds or regex params are used to limit which blocks are validated. Only the matched blocks will be validated, and validation results are shown for only those matched blocks.

Parameters

void

The Validate action validates all blocks on the page if called without params.

string

A blockId of the block to validate.

string[]

An array of blockIds of the blocks to validate.

object

• blockId?: string|string[]: A blockId or an array of the blockIds of the blocks to validate.
• regex?: string|string[]: A regex string pattern or an array of regex string patterns to match the blockIds to validate.

Examples

Validate all inputs on the page:

- id: validate_all
  type: Validate

Validate a single input:

- id: validate_my_input
  type: Validate
  params: my_input

Validate a list of inputs:

- id: validate_input_a_and_b
  type: Validate
  params:
    - my_input_a
    - my_input_b

Validate all inputs matching a regex pattern:

- id: validate_foo
  type: Validate
  params:
    regex: ^foo\.

Validate all inputs matching a list of regex patterns:

- id: validate_foo_and_price
  type: Validate
  params:
    regex:
      - ^foo\.
      - ^.*price.*$

Validate all inputs matching a list of regex patterns and a blockId:

- id: validate_foo_price_and_my_input
  type: Validate
  params:
    blockId: my_input
    regex:
      - ^foo\.
      - ^.*price.*$