Conditional Logic

Conditional logic lets you show or hide fields based on answers to earlier questions. @osforms/react evaluates the rules as the user fills out the form, so fields appear and disappear in real time. The dashboard builder doesn’t have a conditional logic editor yet. Add rules to the field definitions in a local schema, or save them in the form’s schema with PATCH /api/v1/forms/{id}.

Structure

Each field can have one conditionalLogic rule:

{
  "id": "details",
  "type": "textarea",
  "label": "Tell us more",
  "conditionalLogic": {
    "action": "show",
    "match": "all",
    "conditions": [
      {
        "fieldId": "satisfied",
        "operator": "equals",
        "value": "no"
      }
    ]
  }
}

Properties

Property	Type	Description
`action`	`"show"` \| `"hide"`	Whether to show or hide the field when conditions are met
`match`	`"all"` \| `"any"`	`all` = AND logic (every condition must pass), `any` = OR logic
`conditions`	`Condition[]`	One or more conditions to evaluate

Condition Structure

{
  "fieldId": "plan_type",
  "operator": "equals",
  "value": "pro"
}

Property	Type	Description
`fieldId`	`string`	The ID of the field whose value is checked
`operator`	`ConditionOperator`	The comparison to perform
`value`	`string \| number`	The value to compare against (not required for `is_empty` / `is_not_empty`)

Operators

Operator	Description	Works With
`equals`	Exact match	All types
`not_equals`	Does not match	All types
`contains`	Value includes the string	Text types, `checkbox`
`not_contains`	Value does not include the string	Text types, `checkbox`
`greater_than`	Numeric greater than	`number`, `rating`, `scale`
`less_than`	Numeric less than	`number`, `rating`, `scale`
`is_empty`	No value entered	All types except `checkbox`
`is_not_empty`	Any value entered	All types except `checkbox`

For checkbox fields, use contains with the option’s value. equals only matches when exactly that one box is ticked, and an unticked checkbox group doesn’t count as empty.

Examples

Show a follow-up field

Show a text field only when the user selects “Other” from a radio:

{
  "id": "role_other",
  "type": "text",
  "label": "Please specify your role",
  "conditionalLogic": {
    "action": "show",
    "match": "all",
    "conditions": [
      { "fieldId": "role", "operator": "equals", "value": "other" }
    ]
  }
}

Show a field based on NPS score

Show a question only when the NPS score is low:

{
  "id": "what_went_wrong",
  "type": "textarea",
  "label": "What could we improve?",
  "conditionalLogic": {
    "action": "show",
    "match": "all",
    "conditions": [{ "fieldId": "nps", "operator": "less_than", "value": 7 }]
  }
}

Multiple conditions (AND)

Show a field only if the user is a Pro customer AND has submitted before:

{
  "conditionalLogic": {
    "action": "show",
    "match": "all",
    "conditions": [
      { "fieldId": "plan", "operator": "equals", "value": "pro" },
      { "fieldId": "returning", "operator": "equals", "value": "yes" }
    ]
  }
}

Multiple conditions (OR)

Show a field if the user selected either “email” or “phone”:

{
  "conditionalLogic": {
    "action": "show",
    "match": "any",
    "conditions": [
      { "fieldId": "contact_pref", "operator": "equals", "value": "email" },
      { "fieldId": "contact_pref", "operator": "equals", "value": "phone" }
    ]
  }
}

How It Works

Conditions reference fields by ID (the id property on a FormField)
Put the fields a condition depends on before the conditional field in the fields array, so people answer them first
Hidden fields are excluded from the submission: their values are not sent
In conversational mode, hidden fields are skipped in the navigation sequence
statement fields are never included in submissions

Getting Started

Core Concepts

Integrations

Conditional Logic

Structure

Properties

Condition Structure

Operators

Examples

Show a follow-up field

Show a field based on NPS score

Multiple conditions (AND)

Multiple conditions (OR)

How It Works

​Structure

​Properties

​Condition Structure

​Operators

​Examples

​Show a follow-up field

​Show a field based on NPS score

​Multiple conditions (AND)

​Multiple conditions (OR)

​How It Works

Structure

Properties

Condition Structure

Operators

Examples

Show a follow-up field

Show a field based on NPS score

Multiple conditions (AND)

Multiple conditions (OR)

How It Works