Conditionally visible field

IngredientformIngredients

A widget that is visible only if a specified condition is met

Ingredient Family: formIngredients

Outline Display: A conditional widget for {{columnName}} that is only visible when {{shouldShow}} (and is {{defaultValue}} when not shown).

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: any type)
    the column to represent
    Set ty only when columnName names a new column (not in $parentTable).

  • shouldShow : formula (returns bool; required, non-nullable)
    A boolean formula using previous fields that determines whether the widget is visible
    Scope: all columns of $formFieldsTable (reference as [ColumnName], e.g., [Name], [Price])

Optional

  • defaultValue : formula (returns strictOptional (type of columnName))
    The default column value when the widget isn’t visible
    Scope: all columns of $formFieldsTable (reference as [ColumnName], e.g., [Name], [Price])

  • 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

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