An input component is used to capture text input from the end user. You can submit the value of the input by:

  • Adding an action to the input component (which will render an inline button)
  • Using a button component (which will submit all interactive components in the canvas)


ParameterPossible ValuesRequiredDescription
typeinputYesThe type of component you are rendering.
idAny stringYesA unique identifier for the component.
labelAny stringNoThe text shown above the input.
placeholderAny stringNoAn example value shown inside the component when it’s empty.
valueAny stringNoAn entered value which is already inside the component.
actionAction ObjectNoThis can be a Submit Action, URL Action, or Sheets Action.
save_stateunsaved``saved``failedNoStyles the input.Default is unsaved.Prevent action with saved.
disabledfalse``trueNoStyles the input and prevents the action.Default is false.Will be overriden if save_state is saved.