TextField

Forms allow a user to provide input to complete a task.

Usage

import { TextField } from 'nr1'

Examples

Props

ariaLabelstring

Provide a label for screen readers to describe this input. This is only required if the screen reader label should be different to the label prop, or if you are not providing a label prop at all.

ariaLabelledBystring

Provide the unique id of an element whose contents describe this input for screen readers. This is only required if the screen reader label should be different to the label prop, or if you are not providing a label prop at all. Use this or ariaLabel, not both.

autoFocusboolean

DEFAULT

false

If true, the text field will autofocus on mount.

classNamestring

Appends class names to the component.

Should be used only for positioning and spacing purposes.

defaultValuestring

Default value of the text field.

descriptionstring

Message with instructions on how to fill the form field.

disabledboolean

DEFAULT

false

Establishes whether the field can be editable or not.

infostring

Additional information can be displayed in an info tooltip next to the Label.

invalidboolean|string

DEFAULT

false

When true, sets the field in an invalid state, in order to notify the user attention is needed over this particular field. This property can be a boolean field or a string. When it is a string, as well as the invalid state being shown, the text will be shown below.

labelstring

Text to display as label.

labelInlineboolean

Display the label inline the form control.

Use only when the component is not inside a Form. In that case set layoutType to Form.LAYOUT_TYPE.SPLIT in the Form component.

loadingboolean

If loading a list of data or something else into a form field, indicate to the user that something is loading by using the loading state form.

Used to inform that the field might load values dynamically. When set to true, shows a loading spinner; and when set to false, reserves some space in the UI so that the spinner can potentially be shown.

Do not set the property (or set it to undefined) if the field is not expected to get loading at any given point in time.

multilinedeprecatedboolean

DEFAULT

false

Due January 1st, 2022

The "multiline" prop is deprecated, use MultilineTextField component instead for multiline purposes.

Whether the input accepts one or more lines. This also affects the behavior of the [Enter] key, which will create a new line, as opposed to a no-op in a single-line field.

onBlurfunction

Callback which is fired when the text field loses focus.

function (event: React.FocusEvent // Event source of the callback.
)

onChangefunction

Callback which is fired when the text field value changes.

function (event: React.ChangeEvent // Event source of the callback. You
can pull out the new value by accessing event.target.value.
)

onFocusfunction

Callback which is fired when the text field gets focus.

function (event: React.FocusEvent // Event source of the callback.
)

onKeyDownfunction

Callback which is fired when a key is pressed.

function (event: React.KeyboardEvent // Event source of the callback.
)

onKeyUpfunction

Callback which is fired when a key is released.

function (event: React.KeyboardEvent // Event source of the callback.
)

placeholderstring

Hint displayed in the text field when it has no value.

readOnlyboolean

DEFAULT

false

If true, makes the text field read only.

requiredboolean

DEFAULT

false

If true, denotes the form field as required.

spacingTypeenum[]

Spacing property. Spacing is defined as a tuple of zero to four values, which follow the same conventions as CSS properties like margin or padding. To omit a value, use SPACING_TYPE.OMIT.

<Array of<One ofTextField.SPACING_TYPE.EXTRA_LARGE,
TextField.SPACING_TYPE.LARGE,
TextField.SPACING_TYPE.MEDIUM,
TextField.SPACING_TYPE.NONE,
TextField.SPACING_TYPE.OMIT,
TextField.SPACING_TYPE.SMALL,
>
>

spellCheckboolean

DEFAULT

false

If true, enables the browser check for spelling errors.

styleobject

Inline style for custom styling.

Should be used only for positioning and spacing purposes.

testIdstring

Adds a data-test-id attribute.

Use it to target the component in unit and e2e tests.

typeenum

DEFAULT

TextField.TYPE.TEXT

Text — when a user inputs one line of text into a field
Email — when you need a user to enter email address
Search — when a user needs to search
Preformatted — when a user needs to enter code content
Password — when a user enters a password
URL — when a user enters a URL

<One ofTextField.TYPE.EMAIL,
TextField.TYPE.PASSWORD,
TextField.TYPE.PREFORMATTED,
TextField.TYPE.SEARCH,
TextField.TYPE.TEXT,
TextField.TYPE.URL,
>

valuestring

Value of the text field.

This is required for a controlled component.