TextArea
Use a text field to allow merchants to input or modify multiline text.
| Name | Type | Description |
|---|---|---|
| rows | number? |
The initial number of lines to be displayed. Maximum of 8 lines. |
| disabled | boolean? |
Whether the field can be modified. |
| error | string? |
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately. |
| label | string |
Content to use as the field label. |
| onBlur | () => void? |
Callback when focus is removed. |
| onChange | (value: string) => void? |
Callback when the user has finished editing a field. |
| onFocus | () => void? |
Callback when input is focused. |
| onInput | (value: string) => void? |
Callback when the user makes any changes in the field. As noted in the documentation for onChange, you must not use this to update value — use the onChange callback for that purpose. Use the onInput prop when you need to do something as soon as the user makes a change, like clearing validation errors that apply to the field as soon as the user begins making the necessary adjustments. |
| placeholder | string? |
A short hint that describes the expected value of the field. |
| required | boolean? |
Whether the field needs a value. |
| value | string? |
The current value for the field. If omitted, the field will be empty. You should update this value in response to the onChange callback. |
| helpText | string? |
Label under the text field which provides guidance or instructions that assist users. |
| action | InputAction? |
A button under the text field to provide extra funtionality. |
| maxLength | number? |
The maximum number of characters allowed in the input field. |
InputAction
Anchor link to section titled "InputAction"| Name | Type | Description |
|---|---|---|
| label | string |
The text displayed in the button. |
| disabled | boolean? |
Whether the button can be pressed. |
| onPress | () => void |
A callback to be performed. |