documentation /ingredient/formIngredients

Validated input

IngredientformIngredients

An input widget whose value must be validated in order to submit

Ingredient Family: formIngredients

Outline Display: A validated input widget for {{columnName}}, validated according to {{validator}}.

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

Names introduced within this component’s knobs:

  • singleWidgetTable – empty table populated by ingredients

Settings

Required

  • columnName : column of $parentTable or new (type filter: any type)
    the column whose entry must be validated
    Set ty only when columnName names a new column (not in $parentTable).

Optional

  • validator : ingredient slot of validationIngredients(singleWidgetTable) (many)
    Any required validation for the field

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

  • munge : ingredient slot of stringMungeIngredients (many)
    Any modifications to be done on submission

  • 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