YourPlugins

Create input and output fields

Part of Build a calculator.

All docs

Fields are the building blocks of a calculator. In version 3.x, fields are local to the calculator that owns them. This means you create and manage fields from inside the calculator workspace, not as a shared global library.

There are two field modes:

  • Input fields: used by the customer to enter values such as width, height, date, options, or uploads.
  • Output fields: used to show calculated values such as weight, area, discount, or any other result returned by your formula or spreadsheet mapping.

Create a field

  1. Open the calculator you want to edit.
  2. Go to the Fields tab.
  3. Click New Field.
  4. Choose the field mode and field type, then complete the options.
  5. Click Save.

Common field options

  • Label *: the main label displayed on the product page.
  • Cart/summary label: an optional shorter label used in cart and summary contexts. If empty, the main label is used.
  • Formula key *: a stable token used in formulas, for example {{width}}. It is automatically generated from the label, but you can edit it. The value must be unique inside the current calculator.
  • Mode *: choose whether the field is an input or an output.
  • Type *: choose the field type. See Choose the right field type for the available options.
  • Description: internal note for administrators.
  • Visibility options: control whether the field is shown on product, cart, checkout, or order, and whether it should be hidden when empty.

Input field options

  • Required: the customer must complete the field before adding the product to the cart. For checkboxes, Required means the option must be checked.
  • Required error message: custom validation message shown when the field is required and not valid.
  • Text after field: optional helper text displayed after the field value.
  • Check errors: defines when validation is enforced.
  • Type-specific settings: many field types add their own options, such as default values, list items, date formats, image choices, or video choices.

Output field options

  • Hide field on product page: keeps the value available for cart, checkout, or order while hiding it on the single-product page.
  • Numeric formatting: if the output is numeric, you can define decimals, decimal separator, and thousand separator.
  • Text output: output fields can also display strings when the result is textual rather than numeric.

* indicates a required setting.

In the field list you can:

  • Edit: change the field configuration.
  • Clone: duplicate the field inside the same calculator.
  • Delete: permanently remove the field from the current calculator.
Notes:
  • Fields are calculator-specific in version 3.x. Editing a field in one calculator does not update other calculators.
  • For formula-based calculators, only field types that return calculable values can be used directly inside a formula.
  • The plugin does not impose a fixed limit on the number of fields in a calculator, but large calculators should still be tested carefully in Preview.