Skip to main content

InputFieldDefinition Input Object

Represents an input field for a Component Action.

Input fields#

ArgumentTypeDescription
keyString!A string which uniquely identifies the InputField in the context of the Action.
labelString!The name of the InputField.
typeString!Specifies the type of data the InputField handles.
collectionStringSpecifies the type of collection to use for storing input values, if applicable.
placeholderStringPlaceholder text that will appear in the InputField UI.
defaultStringThe default value for the InputField.
commentsStringAdditional notes about the InputField.
exampleStringAn example valid input for this InputField.
requiredBooleanSpecifies whether the InputField is required by the Action.
model[InputFieldChoice]Dictates how possible choices are provided for this InputField.
languageStringLanguage to use for the Code Field.