Skip to main content

ICondition interface

📖 Description​

Interface that describes a condition within the form definition.

tip

See the form definition interface for more information about conditions.

📃 Type declaration​

interface ICondition {
  id: string;Readonly
  disabled?: boolean;ReadonlyOptional
  block?: {
    type: string;
    version: string;
    branch?: string;
    section?: string;
    node?: string;
    slot?: string;
  };ReadonlyOptional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ block​

Specifies the block for the condition. A condition block implements the actual behavior of a condition.

Type​

{
  /* Contains the condition block type identifier. */
  type: string;

  /* Contains the version of the block. */
  version: string;

  /* Contains the id of a related branch. */
  branch?: string;

  /* Contains the id of a related section. */
  section?: string;

  /* Contains the id of a related node. */
  node?: string;

  /* Contains the id of a related slot. */
  slot?: string;
}
info

Besides the listed properties, condition blocks may store additional properties in the block object.

🏷ī¸ disabled​

Specifies if the condition is disabled. Disabled conditions are ignored by the runners as if they did not exist.

Type​

boolean

🏷ī¸ id​

Specifies the unique identifier of the condition.

Type​

string