New `prefill` Property for Inputs
Available on: Open Source EditionEnterprise Edition
Release: 1.1.0
Overview
A new prefill property has been added to input definitions to let users start with an initial value that can be cleared or set to null when the input is not required.
What changed:
Inputs can now define a prefill value, which works like an editable default. Unlike defaults, a prefill value does not persist if the user removes it. This allows workflows to support optional inputs that start with a suggestion but can still be reset to null at runtime.
Impact:
While not a breaking change, this update clarifies how required, defaults, and prefill behave together:
prefillanddefaultscannot be used on the same input.- Use
prefillwhenrequired: falseand the user should be able to clear the value. - Use
defaultswhenrequired: trueor when the value must always have a non-null default. - If
defaultsis used withrequired: false, the value will still reset to the default when cleared, which may not be desired; useprefillrather thandefaultsfor those scenarios.
Example:
inputs:
- id: nullable_string_with_prefilled_default
type: STRING
prefill: "This is a prefilled value you can remove (set to null if needed)"
required: false
Migration: No migration is required. For optional inputs that previously used defaults but need to allow clearing or null values, switch to using prefill.
Was this page helpful?