Describes a single input field expected by an
Action, including its constraints and any
validation error from a previous submission attempt.Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string
|
The name of the input field. | |
type |
string
|
The input's type (e.g. `string`, `boolean`), as reported by the backend. | |
value |
TValue
|
<optional> |
The current or previously submitted value, if any. |
min_length |
number
|
<optional> |
The minimum allowed length, for string inputs. |
max_length |
number
|
<optional> |
The maximum allowed length, for string inputs. |
required |
boolean
|
<optional> |
Indicates whether the input must be provided to run the action. |
hidden |
boolean
|
<optional> |
Indicates whether the input should not be shown in a UI. |
error |
FlowError
|
<optional> |
A validation error for this specific input, if the last submission failed. |
allowed_values |
Array.<AllowedInputValues>
|
<optional> |
The set of allowed values, if the input is restricted to a fixed list. |