documentation /ingredient/formIngredients

Toggle switch

IngredientformIngredients

A toggle switch for a boolean field

Ingredient Family: formIngredients

Outline Display: A toggle switch to set {{columnName}}.

Local scope

The parent slot binds these (look up the slot in the parent to see how):

  • $parentTable – The table (if any) that this form is based on
  • $formFieldsTable – A table of form fields that is built up through the sequence of form ingredients

Settings

Required

  • columnName : column of $parentTable or new (type filter: exactly bool; required, non-nullable)
    The column to represent as a toggle
    Set ty only when columnName names a new column (not in $parentTable).

Optional

  • customLabel : formula (returns text; optional)
    A custom label for the toggle switch (leaving this empty uses the column name as the label).
    Scope: none – this formula does not accept column references or handler params.

  • cssWidth : constant value (type: integer; required, non-nullable)
    Width between 1 and 12

  • compact : constant value (type: bool; required, non-nullable)
    Should this widget be vertically compact? Choosing compact will put the label to the left of the widget, while choosing non-compact will put it above