You are viewing the legacy documentation of Plasma featuring the components from the@coveord/plasma-react and @coveord/plasma-style packages. Those packages are deprecated and replaced by the @coveord/plasma-mantine package.

Text Input

A text input allows users to enter and edit short texts, such as names, emails, and passwords.

View source

Title

Description

Label

Help text

1
import {FormProvider, InputValidator, TextInput} from '@coveord/plasma-react';
2

3
const nonEmptyValidation: InputValidator = (value: string) => {
4
    const isEmpty = !value;
5
    const isWhiteSpace = !isEmpty && !value.trim();
6

7
    if (isWhiteSpace) {
8
        return {status: 'warning', message: 'A white space is not empty, but is not ideal.'};
9
    }
10

11
    if (isEmpty) {
12
        return {status: 'invalid', message: 'Cannot be empty.'};
13
    }
14

15
    return {status: 'valid'};
16
};
17

18
export default () => (
19
    <FormProvider>
20
        <TextInput
21
            required
22
            showValidationOnBlur
23
            validate={nonEmptyValidation}
24
            type="text"
25
            label="Label"
26
            title="Title"
27
            description="Description"
28
            helpText="Help text"
29
            tooltip="Tooltip"
30
        />
31
    </FormProvider>
32
);

Props

Name	Type	Description
`label`required	`string`	The text displayed inside the input box
`type`required	`"email" \| "search" \| "text" \| "url" \| "password"`	Tells the browser which type of text content to expect
`"aria-activedescendant"`	`string`	Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
`"aria-atomic"`	`Booleanish`	Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
`"aria-autocomplete"`	`"list" \| "none" \| "inline" \| "both"`	Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
`"aria-busy"`	`Booleanish`	Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
`"aria-checked"`	`boolean \| "true" \| "false" \| "mixed"`	Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
`"aria-colcount"`	`number`	Defines the total number of columns in a table, grid, or treegrid.
`"aria-colindex"`	`number`	Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
`"aria-colspan"`	`number`	Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
`"aria-controls"`	`string`	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`"aria-current"`	`boolean \| "step" \| "true" \| "false" \| "page" \| "location" \| "date" \| "time"`	Indicates the element that represents the current item within a container or set of related elements.
`"aria-describedby"`	`string`	Identifies the element (or elements) that describes the object.
`"aria-details"`	`string`	Identifies the element that provides a detailed, extended description for the object.
`"aria-disabled"`	`Booleanish`	Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
`"aria-errormessage"`	`string`	Identifies the element that provides an error message for the object.
`"aria-expanded"`	`Booleanish`	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
`"aria-flowto"`	`string`	Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
`"aria-haspopup"`	`boolean \| "true" \| "false" \| "menu" \| "listbox" \| "tree" \| "grid" \| "dialog"`	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`"aria-hidden"`	`Booleanish`	Indicates whether the element is exposed to an accessibility API.
`"aria-invalid"`	`boolean \| "true" \| "false" \| "grammar" \| "spelling"`	Indicates the entered value does not conform to the format expected by the application.
`"aria-keyshortcuts"`	`string`	Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
`"aria-label"`	`string`	Defines a string value that labels the current element.
`"aria-labelledby"`	`string`	Identifies the element (or elements) that labels the current element.
`"aria-level"`	`number`	Defines the hierarchical level of an element within a structure.
`"aria-live"`	`"off" \| "assertive" \| "polite"`	Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
`"aria-modal"`	`Booleanish`	Indicates whether an element is modal when displayed.
`"aria-multiline"`	`Booleanish`	Indicates whether a text box accepts multiple lines of input or only a single line.
`"aria-multiselectable"`	`Booleanish`	Indicates that the user may select more than one item from the current selectable descendants.
`"aria-orientation"`	`"horizontal" \| "vertical"`	Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
`"aria-owns"`	`string`	Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
`"aria-placeholder"`	`string`	Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
`"aria-posinset"`	`number`	Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
`"aria-pressed"`	`boolean \| "true" \| "false" \| "mixed"`	Indicates the current "pressed" state of toggle buttons.
`"aria-readonly"`	`Booleanish`	Indicates that the element is not editable, but is otherwise operable.
`"aria-relevant"`	`"text" \| "additions" \| "additions removals" \| "additions text" \| "all" \| "removals" \| "removals additions" \| "removals text" \| "text additions" \| "text removals"`	Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
`"aria-required"`	`Booleanish`	Indicates that user input is required on the element before a form may be submitted.
`"aria-roledescription"`	`string`	Defines a human-readable, author-localized description for the role of an element.
`"aria-rowcount"`	`number`	Defines the total number of rows in a table, grid, or treegrid.
`"aria-rowindex"`	`number`	Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
`"aria-rowspan"`	`number`	Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
`"aria-selected"`	`Booleanish`	Indicates the current "selected" state of various widgets.
`"aria-setsize"`	`number`	Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
`"aria-sort"`	`"none" \| "ascending" \| "descending" \| "other"`	Indicates if items in a table or grid are sorted in ascending or descending order.
`"aria-valuemax"`	`number`	Defines the maximum allowed value for a range widget.
`"aria-valuemin"`	`number`	Defines the minimum allowed value for a range widget.
`"aria-valuenow"`	`number`	Defines the current value for a range widget.
`"aria-valuetext"`	`string`	Defines the human readable text alternative of aria-valuenow for a range widget.
`about`	`string`
`accept`	`string`
`accessKey`	`string`
`alt`	`string`
`autoCapitalize`	`string`
`autoComplete`	`string`
`autoCorrect`	`string`
`autoFocus`	`boolean`
`autoSave`	`string`
`capture`	`boolean \| "user" \| "environment"`
`checked`	`boolean`
`children`	`React.ReactNode & React.ReactNode`
`className`	`string`
`color`	`string`
`contentEditable`	`Booleanish \| "inherit"`
`contextMenu`	`string`
`crossOrigin`	`string`
`dangerouslySetInnerHTML`	`{ __html: string; }`
`datatype`	`string`
`defaultChecked`	`boolean`
`defaultValue`	`string`	The initial value
`description`	`string`	The text displayed just above the input box
`dir`	`string`
`disabled`	`boolean`
`draggable`	`Booleanish`
`enterKeyHint`	`"search" \| "enter" \| "done" \| "go" \| "next" \| "previous" \| "send"`
`form`	`string`
`formAction`	`string`
`formEncType`	`string`
`formMethod`	`string`
`formNoValidate`	`boolean`
`formTarget`	`string`
`height`	`string \| number`
`helpText`	`string`	The text displayed just underneath the input box
`hidden`	`boolean`
`id`	`string`
`inlist`	`any`
`inputMode`	`"email" \| "search" \| "text" \| "url" \| "none" \| "tel" \| "numeric" \| "decimal"`	Hints at the type of data that might be entered by the user while editing the element or its contents
`is`	`string`	Specify that a standard HTML element should behave like a defined custom built-in element
`itemID`	`string`
`itemProp`	`string`
`itemRef`	`string`
`itemScope`	`boolean`
`itemType`	`string`
`lang`	`string`
`list`	`string`
`max`	`string \| number`
`maxLength`	`number`
`min`	`string \| number`
`minLength`	`number`
`multiple`	`boolean`
`name`	`string`
`nonce`	`string`
`onAbort`	`ReactEventHandler<HTMLInputElement>`
`onAbortCapture`	`ReactEventHandler<HTMLInputElement>`
`onAnimationEnd`	`AnimationEventHandler<HTMLInputElement>`
`onAnimationEndCapture`	`AnimationEventHandler<HTMLInputElement>`
`onAnimationIteration`	`AnimationEventHandler<HTMLInputElement>`
`onAnimationIterationCapture`	`AnimationEventHandler<HTMLInputElement>`
`onAnimationStart`	`AnimationEventHandler<HTMLInputElement>`
`onAnimationStartCapture`	`AnimationEventHandler<HTMLInputElement>`
`onAuxClick`	`MouseEventHandler<HTMLInputElement>`
`onAuxClickCapture`	`MouseEventHandler<HTMLInputElement>`
`onBeforeInput`	`FormEventHandler<HTMLInputElement>`
`onBeforeInputCapture`	`FormEventHandler<HTMLInputElement>`
`onBlur`	`FocusEventHandler<HTMLInputElement>`
`onBlurCapture`	`FocusEventHandler<HTMLInputElement>`
`onCanPlay`	`ReactEventHandler<HTMLInputElement>`
`onCanPlayCapture`	`ReactEventHandler<HTMLInputElement>`
`onCanPlayThrough`	`ReactEventHandler<HTMLInputElement>`
`onCanPlayThroughCapture`	`ReactEventHandler<HTMLInputElement>`
`onChange`	`ChangeEventHandler<HTMLInputElement>`
`onChangeCapture`	`FormEventHandler<HTMLInputElement>`
`onClick`	`MouseEventHandler<HTMLInputElement>`
`onClickCapture`	`MouseEventHandler<HTMLInputElement>`
`onCompositionEnd`	`CompositionEventHandler<HTMLInputElement>`
`onCompositionEndCapture`	`CompositionEventHandler<HTMLInputElement>`
`onCompositionStart`	`CompositionEventHandler<HTMLInputElement>`
`onCompositionStartCapture`	`CompositionEventHandler<HTMLInputElement>`
`onCompositionUpdate`	`CompositionEventHandler<HTMLInputElement>`
`onCompositionUpdateCapture`	`CompositionEventHandler<HTMLInputElement>`
`onContextMenu`	`MouseEventHandler<HTMLInputElement>`
`onContextMenuCapture`	`MouseEventHandler<HTMLInputElement>`
`onCopy`	`ClipboardEventHandler<HTMLInputElement>`
`onCopyCapture`	`ClipboardEventHandler<HTMLInputElement>`
`onCut`	`ClipboardEventHandler<HTMLInputElement>`
`onCutCapture`	`ClipboardEventHandler<HTMLInputElement>`
`onDoubleClick`	`MouseEventHandler<HTMLInputElement>`
`onDoubleClickCapture`	`MouseEventHandler<HTMLInputElement>`
`onDrag`	`DragEventHandler<HTMLInputElement>`
`onDragCapture`	`DragEventHandler<HTMLInputElement>`
`onDragEnd`	`DragEventHandler<HTMLInputElement>`
`onDragEndCapture`	`DragEventHandler<HTMLInputElement>`
`onDragEnter`	`DragEventHandler<HTMLInputElement>`
`onDragEnterCapture`	`DragEventHandler<HTMLInputElement>`
`onDragExit`	`DragEventHandler<HTMLInputElement>`
`onDragExitCapture`	`DragEventHandler<HTMLInputElement>`
`onDragLeave`	`DragEventHandler<HTMLInputElement>`
`onDragLeaveCapture`	`DragEventHandler<HTMLInputElement>`
`onDragOver`	`DragEventHandler<HTMLInputElement>`
`onDragOverCapture`	`DragEventHandler<HTMLInputElement>`
`onDragStart`	`DragEventHandler<HTMLInputElement>`
`onDragStartCapture`	`DragEventHandler<HTMLInputElement>`
`onDrop`	`DragEventHandler<HTMLInputElement>`
`onDropCapture`	`DragEventHandler<HTMLInputElement>`
`onDurationChange`	`ReactEventHandler<HTMLInputElement>`
`onDurationChangeCapture`	`ReactEventHandler<HTMLInputElement>`
`onEmptied`	`ReactEventHandler<HTMLInputElement>`
`onEmptiedCapture`	`ReactEventHandler<HTMLInputElement>`
`onEncrypted`	`ReactEventHandler<HTMLInputElement>`
`onEncryptedCapture`	`ReactEventHandler<HTMLInputElement>`
`onEnded`	`ReactEventHandler<HTMLInputElement>`
`onEndedCapture`	`ReactEventHandler<HTMLInputElement>`
`onError`	`ReactEventHandler<HTMLInputElement>`
`onErrorCapture`	`ReactEventHandler<HTMLInputElement>`
`onFocus`	`FocusEventHandler<HTMLInputElement>`
`onFocusCapture`	`FocusEventHandler<HTMLInputElement>`
`onGotPointerCapture`	`PointerEventHandler<HTMLInputElement>`
`onGotPointerCaptureCapture`	`PointerEventHandler<HTMLInputElement>`
`onInput`	`FormEventHandler<HTMLInputElement>`
`onInputCapture`	`FormEventHandler<HTMLInputElement>`
`onInvalid`	`FormEventHandler<HTMLInputElement>`
`onInvalidCapture`	`FormEventHandler<HTMLInputElement>`
`onKeyDown`	`KeyboardEventHandler<HTMLInputElement>`
`onKeyDownCapture`	`KeyboardEventHandler<HTMLInputElement>`
`onKeyUp`	`KeyboardEventHandler<HTMLInputElement>`
`onKeyUpCapture`	`KeyboardEventHandler<HTMLInputElement>`
`onLoad`	`ReactEventHandler<HTMLInputElement>`
`onLoadCapture`	`ReactEventHandler<HTMLInputElement>`
`onLoadedData`	`ReactEventHandler<HTMLInputElement>`
`onLoadedDataCapture`	`ReactEventHandler<HTMLInputElement>`
`onLoadedMetadata`	`ReactEventHandler<HTMLInputElement>`
`onLoadedMetadataCapture`	`ReactEventHandler<HTMLInputElement>`
`onLoadStart`	`ReactEventHandler<HTMLInputElement>`
`onLoadStartCapture`	`ReactEventHandler<HTMLInputElement>`
`onLostPointerCapture`	`PointerEventHandler<HTMLInputElement>`
`onLostPointerCaptureCapture`	`PointerEventHandler<HTMLInputElement>`
`onMouseDown`	`MouseEventHandler<HTMLInputElement>`
`onMouseDownCapture`	`MouseEventHandler<HTMLInputElement>`
`onMouseEnter`	`MouseEventHandler<HTMLInputElement>`
`onMouseLeave`	`MouseEventHandler<HTMLInputElement>`
`onMouseMove`	`MouseEventHandler<HTMLInputElement>`
`onMouseMoveCapture`	`MouseEventHandler<HTMLInputElement>`
`onMouseOut`	`MouseEventHandler<HTMLInputElement>`
`onMouseOutCapture`	`MouseEventHandler<HTMLInputElement>`
`onMouseOver`	`MouseEventHandler<HTMLInputElement>`
`onMouseOverCapture`	`MouseEventHandler<HTMLInputElement>`
`onMouseUp`	`MouseEventHandler<HTMLInputElement>`
`onMouseUpCapture`	`MouseEventHandler<HTMLInputElement>`
`onPaste`	`ClipboardEventHandler<HTMLInputElement>`
`onPasteCapture`	`ClipboardEventHandler<HTMLInputElement>`
`onPause`	`ReactEventHandler<HTMLInputElement>`
`onPauseCapture`	`ReactEventHandler<HTMLInputElement>`
`onPlay`	`ReactEventHandler<HTMLInputElement>`
`onPlayCapture`	`ReactEventHandler<HTMLInputElement>`
`onPlaying`	`ReactEventHandler<HTMLInputElement>`
`onPlayingCapture`	`ReactEventHandler<HTMLInputElement>`
`onPointerCancel`	`PointerEventHandler<HTMLInputElement>`
`onPointerCancelCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerDown`	`PointerEventHandler<HTMLInputElement>`
`onPointerDownCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerEnter`	`PointerEventHandler<HTMLInputElement>`
`onPointerEnterCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerLeave`	`PointerEventHandler<HTMLInputElement>`
`onPointerLeaveCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerMove`	`PointerEventHandler<HTMLInputElement>`
`onPointerMoveCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerOut`	`PointerEventHandler<HTMLInputElement>`
`onPointerOutCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerOver`	`PointerEventHandler<HTMLInputElement>`
`onPointerOverCapture`	`PointerEventHandler<HTMLInputElement>`
`onPointerUp`	`PointerEventHandler<HTMLInputElement>`
`onPointerUpCapture`	`PointerEventHandler<HTMLInputElement>`
`onProgress`	`ReactEventHandler<HTMLInputElement>`
`onProgressCapture`	`ReactEventHandler<HTMLInputElement>`
`onRateChange`	`ReactEventHandler<HTMLInputElement>`
`onRateChangeCapture`	`ReactEventHandler<HTMLInputElement>`
`onReset`	`FormEventHandler<HTMLInputElement>`
`onResetCapture`	`FormEventHandler<HTMLInputElement>`
`onResize`	`ReactEventHandler<HTMLInputElement>`
`onResizeCapture`	`ReactEventHandler<HTMLInputElement>`
`onScroll`	`UIEventHandler<HTMLInputElement>`
`onScrollCapture`	`UIEventHandler<HTMLInputElement>`
`onSeeked`	`ReactEventHandler<HTMLInputElement>`
`onSeekedCapture`	`ReactEventHandler<HTMLInputElement>`
`onSeeking`	`ReactEventHandler<HTMLInputElement>`
`onSeekingCapture`	`ReactEventHandler<HTMLInputElement>`
`onSelect`	`ReactEventHandler<HTMLInputElement>`
`onSelectCapture`	`ReactEventHandler<HTMLInputElement>`
`onStalled`	`ReactEventHandler<HTMLInputElement>`
`onStalledCapture`	`ReactEventHandler<HTMLInputElement>`
`onSubmit`	`FormEventHandler<HTMLInputElement>`
`onSubmitCapture`	`FormEventHandler<HTMLInputElement>`
`onSuspend`	`ReactEventHandler<HTMLInputElement>`
`onSuspendCapture`	`ReactEventHandler<HTMLInputElement>`
`onTimeUpdate`	`ReactEventHandler<HTMLInputElement>`
`onTimeUpdateCapture`	`ReactEventHandler<HTMLInputElement>`
`onTouchCancel`	`TouchEventHandler<HTMLInputElement>`
`onTouchCancelCapture`	`TouchEventHandler<HTMLInputElement>`
`onTouchEnd`	`TouchEventHandler<HTMLInputElement>`
`onTouchEndCapture`	`TouchEventHandler<HTMLInputElement>`
`onTouchMove`	`TouchEventHandler<HTMLInputElement>`
`onTouchMoveCapture`	`TouchEventHandler<HTMLInputElement>`
`onTouchStart`	`TouchEventHandler<HTMLInputElement>`
`onTouchStartCapture`	`TouchEventHandler<HTMLInputElement>`
`onTransitionEnd`	`TransitionEventHandler<HTMLInputElement>`
`onTransitionEndCapture`	`TransitionEventHandler<HTMLInputElement>`
`onVolumeChange`	`ReactEventHandler<HTMLInputElement>`
`onVolumeChangeCapture`	`ReactEventHandler<HTMLInputElement>`
`onWaiting`	`ReactEventHandler<HTMLInputElement>`
`onWaitingCapture`	`ReactEventHandler<HTMLInputElement>`
`onWheel`	`WheelEventHandler<HTMLInputElement>`
`onWheelCapture`	`WheelEventHandler<HTMLInputElement>`
`pattern`	`string`
`placeholder`	`string`
`prefix`	`string`
`property`	`string`
`radioGroup`	`string`
`readOnly`	`boolean`
`required`	`boolean`
`resource`	`string`
`results`	`number`
`role`	`AriaRole`
`security`	`string`
`showValidationOnBlur`	`boolean`	Whether the validation result should be visible when the input looses the focus (recommended)
`showValidationOnChange`	`boolean`	Whether the validation result should be visible when the input value changes
`showValidationOnMount`	`boolean`	Whether the validation result should be visible when the input is rendered for the first time
`size`	`number`
`slot`	`string`
`spellCheck`	`Booleanish`
`src`	`string`
`step`	`string \| number`
`style`	`CSSProperties`
`suppressContentEditableWarning`	`boolean`
`suppressHydrationWarning`	`boolean`
`tabIndex`	`number`
`title`	`string`
`tooltip`	`string`	Additional text to display as tooltip when hovering over a question icon
`translate`	`"yes" \| "no"`
`typeof`	`string`
`unselectable`	`"off" \| "on"`
`validate`	`InputValidator`	Provides the validation logic to the input
`value`	`string \| number \| readonly string[]`
`vocab`	`string`
`width`	`string \| number`
`"aria-dropeffect"`deprecated	`"none" \| "link" \| "copy" \| "execute" \| "move" \| "popup"`	in ARIA 1.1 Indicates what functions can be performed when a dragged object is released on the drop target.
`"aria-grabbed"`deprecated	`Booleanish`	in ARIA 1.1 Indicates an element's "grabbed" state in a drag-and-drop operation.
`onKeyPress`deprecated	`KeyboardEventHandler<HTMLInputElement>`
`onKeyPressCapture`deprecated	`KeyboardEventHandler<HTMLInputElement>`

Examples

useTextInput hook usage

Favorite Dish (Optional)

state = {
    "value": "",
    "status": "indeterminate",
    "message": "",
    "visibleStatus": false,
    "isDirty": false
}

1
import {Button, FormProvider, TextInput, useTextInput} from '@coveord/plasma-react';
2
import {FunctionComponent} from 'react';
3

4
const CurrentState: FunctionComponent = () => {
5
    const {state} = useTextInput('favorite-dish');
6
    return (
7
        <div className="my1" style={{whiteSpace: 'pre-wrap'}}>
8
            state = {JSON.stringify(state, null, 4)}
9
        </div>
10
    );
11
};
12

13
const InteractiveButtons: FunctionComponent = () => {
14
    const {state, dispatch} = useTextInput('favorite-dish');
15
    return (
16
        <>
17
            <Button
18
                name='Change dish for "sushis"'
19
                enabled={state.value !== 'sushis'}
20
                onClick={() => dispatch({type: 'change-value', payload: 'sushis'})}
21
            />
22
            <Button name="Show validation" onClick={() => dispatch({type: 'show-validation'})} />
23
            <Button name="Hide validation" onClick={() => dispatch({type: 'hide-validation'})} />
24
        </>
25
    );
26
};
27

28
export default () => (
29
    <FormProvider>
30
        <TextInput
31
            id="favorite-dish"
32
            type="text"
33
            label="Favorite Dish"
34
            defaultValue="pizza"
35
            validate={(value) =>
36
                /pizza/i.test(value)
37
                    ? {status: 'valid'}
38
                    : {status: 'warning', message: "Pizza is best but that's okay."}
39
            }
40
            showValidationOnBlur
41
        />
42
        <CurrentState />
43
        <InteractiveButtons />
44
    </FormProvider>
45
);

Best Practices

Use a text input to have users enter a short line of text.

The width of a text input should be proportional to the expected user input and large enough to display the entire text.

Labeling

Keep labels short, preferably under three words.

Provide a descriptive title without action verbs. For example, write "Email" rather than "Enter your email".

Help Text and Instructions

Help text provides extra guidance on what information to provide or how the user should fill it in, for example when there are character restrictions.

Help text should be short, preferably on one line. There are two ways to provide help text:

Written instructions (e.g., "Provide your business email.")
Example (e.g., "E.g., johndoe@acme.com")

A combination of both is also acceptable.

The label of the text input should be self-explanatory. Add a title and description when providing additional guidance is critical for the user to understand why the information is required or how the information will be used.

Feedback and Validation

If there are character restrictons, consider indicating them in the help text. Avoid relying only on the validation message to inform the user about them.

If the user provides text that doesn't meet the requirements, the validation message should clearly indicate how to fix it.

If providing the information is optional, the text input will be automatically tagged as such, indicating that the input can be left blank.

Related Components

If your use case doesn't match the guidelines above, consider using one of the following components instead:

Text Area - When users need to enter longer text.
Numeric input - When only numerical characters are allowed.
Single select - When users need to select an option from a list instead.

Edit guidelines