NUI-Widgets documentation has moved to Storybook hosted on Github Pages.

TextArea

import TextArea from '@concur/nui-widgets/lib/Forms/TextArea';

Text area form controls are used to gather potentially lengthy input from a user. Best practice is to use this component as a child of FormGroup.

Examples

Sizes

Three sizes are supported: 'lg' (the default), 'md' and 'sm'. Use the size property to set the size.

<TextArea />

<TextArea size='md' />

<TextArea size='sm' />

Disabled State

Set the disabled property to change the TextArea’s state to disabled. A disabled element is unusable and un-clickable.

<TextArea disabled />

ReadOnly State

Set the readOnly property to change the TextArea’s state to readOnly. A read-only field cannot be modified. However, a user can tab to it, highlight it, and copy the text from it.

<TextArea readOnly />

Usage

Properties

Property Type Default Description
className String   Any custom classes to add to the <textarea> element.
disabled Boolean false Controls whether the component is enabled or disabled.
id String   Sets the id attribute on the <textarea> element. If used within a FormGroup, the controlId property will be used instead.
inputRef Ref or Function   Attaches a ref to the <input> element.
isResizableX Boolean false Sets if the textarea can be resized by the user horizontally
isResizableY Boolean true Sets if the textarea can be resized by the user vertically
readOnly Boolean false Adds the readonly attribute to the <textarea> element.
required Boolean false Adds the required attribute to the <textarea> element. NOTE: This does not perform any validation, but rather just marks the field as required.
size String 'lg' Size of the <input> element. Options are 'lg', 'md', 'sm'.
validationMessageState String   If used in conjunction with field validation, this provides the icon next to the label. Options are 'error', 'warning'.

Callbacks

Property Parameters Description
onBlur event Callback function for onBlur events.
onFocus event Callback function for onFocus events.