Text field - Frameworks

A text field is a single-line input component used for entering and editing textual data.

AndroidreleasedElementsreleasediOSreleasedReactreleasedVuereleased

React

AndroidElementsiOSReactVue

Import

You can import the component like so:

import { TextField } from '@warp-ds/react';

or import it individually to optimize your JS bundle size by adding only the components you need:

import { TextField } from '@warp-ds/react/components/textfield';

Syntax

<TextField label="Name" />

Props

Optional props

Name	Type	Default	Description
type	"number" |"text" |"search" |"email" |"password" |"url" |"tel"		The type of input to render. See MDN.
autoFocus	boolean		Whether the element should receive focus on render.
className	string		Additional classes to include.
style	CSSProperties		Additional CSS styles for the container.
defaultValue	string & (string|number|readonly string[])		The default value (uncontrolled).
disabled	boolean		Whether the input is disabled.
error	boolean		Renders the field in an invalid state. Often paired together with helpText to provide feedback about the error. @deprecated use invalid instead.
invalid	boolean		Renders the field in an invalid state. Often paired together with helpText to provide feedback about the error.
helpText	ReactNode		The content to display as the help text.
id	string		The element's unique identifier. See MDN.
label	ReactNode		The content to display as the label.
max	string|number		Standard input max attribute, to be used with type="number". See MDN.
min	string|number		Standard input min attribute, to be used with type="number". See MDN.
maxLength	number		The maximum number of characters supported by the input. See MDN.
minLength	number		The minimum number of characters supported by the input. See MDN.
name	string		The name of the input element, used when submitting an HTML form. See MDN.
pattern	string		Regex pattern that the value of the input must match to be valid. See MDN.
placeholder	string		Text hint that occupies the text input when it is empty.
readOnly	boolean		Whether the input can be selected but not changed by the user.
required	boolean		Whether user input is required on the input before form submission.
children	ReactNode		For affix use.
value	string		The current value (controlled).
optional	boolean		Indicates that the textfield is not required.

Value

A TextField's value is empty by default, but an initial, uncontrolled, value can be provided using the defaultValue prop. Alternatively, a controlled value can be provided using the value prop.

function Example() {
  let [value, setValue] = React.useState('me@email.com');

  return (
    <div className="flex space-x-32">
      <TextField label="Email (Uncontrolled)" defaultValue="me@email.com" />

      <TextField
        label="Email (Controlled)"
        value={value}
        onChange={(event) => setValue(event.target.value)}
      />
    </div>
  );
}

Labeling

A visual label should be provided for the TextField using the label prop.

Optional

Add the optional prop to indicate that the textfield is not required.

<TextField label="Telefonnummer" optional />

Help text

TextFields can provide additional context with helpText if the label and placeholder aren't enough.

<TextField
  label="Telefonnummer"
  helpText="Vil kun brukes til brukerverifisering"
/>

Validation

TextFields can communicate to the user whether the current value is invalid. Implement your own validation logic in your app and set the invalid prop to display it as invalid.

invalid is often paired with helpText to provide feedback to the user about the error.

<TextField label="Email" invalid helpText="Ugyldig e-post" />

Visual options

Placeholder

<TextField label="E-post" placeholder="puse@finn.no" />

Placeholder text can be used to describe the expected value or formatting for the TextField. Placeholder text will only appear when the TextField is empty, and should not be used as a substitute for labeling the component with a visible label.

Disabled

Keep in mind that using disabled in its current form is an anti-pattern. There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons. Please consider more informative alternatives before choosing to use disabled on an element.

<div className="flex flex-col space-y-32">
  <TextField label="E-post" disabled value="puse@finn.no" />
  <TextField label="E-post" disabled />
</div>

Affix

If you wish to use an affix you must first import the Affix component.

import { Affix } from '@warp-ds/react';

Then you include it as a child of TextField component and pass the appropiate props (see bottom of this page for types)

<TextField label="Price" placeholder="1 000 000">
  <Affix suffix label="kr" />
</TextField>

<TextField label="Price" placeholder="1 000 000">
  <Affix prefix label="kr" />
</TextField>

<TextField>
  <Affix suffix clear aria-label="Clear text" onClick={() => alert('clear')} />
</TextField>

<TextField>
  <Affix suffix search aria-label="Search" onClick={() => alert('search')} />
</TextField>

For prefixes wider than 40px, push the input further to the right by setting a --w-prefix-width value on the TextField component. This will increase left padding of its input element. This value needs to be hardcoded until we find a more robust solution.

<TextField className="[--w-prefix-width:56px]" label="Price in kroner">
  <Affix prefix label="kroner" />
</TextField>

You can also use both a prefix and suffix

<TextField>
  <Affix prefix label="kr" />
  <Affix suffix search aria-label="Search" onClick={() => alert('search')} />
</TextField>

You cannot set the type of the Affix. type of the button rendered as Affix will be submit if you pass search as a prop, reset if you pass clear and undefined in other cases.

Affix props

Name	Type	Default	Description
aria-label	string		Defines a string value that labels the affix element
prefix	boolean		Affix added at the beginning of input
suffix	boolean		Affix added at the end of input
clear	boolean		Displays a clear icon
search	boolean		Displays a search icon
label	string		Displays a string

Events

Name	Description
onClick	() => void

Read only

The readOnly boolean prop makes the TextField's text content immutable. Unlike disabled the TextField remains focusable and the contents can still be copied. See the MDN docs for more information.

<div className="flex flex-col space-y-32">
  <TextField label="E-post" readOnly value="puse@finn.no" />
  <TextField label="E-post" readOnly />
</div>

Questions?

Feel free to ask any questions on usage in the Warp DS Slack channel: #warp-design-system