Type Alias: TextPrompt

type TextPrompt = {
  default?: string;
  key: string;
  label: string;
  mask?: MaskOptions;
  maxItems?: number;
  multiple?: boolean;
  optional?: boolean;
  placeholder?: string;
  sendAsFormatted?: boolean;
  type: Text;
  validation?: ValidationOptions;
};

Properties

Property	Type	Description
`default?`	`string`	The default value for the prompt.
`key`	`string`	A unique identifier for the prompt. This will be used as the key in the response object.
`label`	`string`	The label displayed to the user.
`mask?`	`MaskOptions`	Adds client-side input masking.
`maxItems?`	`number`	If multiple is true, the maximum number of items to allow in the array.
`multiple?`	`boolean`	If true, the user will be able to enter multiple values and the response value will be in the form of an array.
`optional?`	`boolean`	If true, allows the user to submit the form without entering a value.
`placeholder?`	`string`	Placeholder text to display.
`sendAsFormatted?`	`boolean`	If true and masking is enabled, sends the masked value instead of the raw value.
`type`	`Text`	-
`validation?`	`ValidationOptions`	Adds client-side validation to the text input. See ValidationOptions for more information.