/

<TextInput> Component

A text input to be used within Formik forms.

Share
Code Editor
<TextInput

  field={{ name: 'example', value: 'test', readOnly: true }}

  form={{ errors: {}, touched: {} }}

/>

Where it's used

Latest:5.0.2
Search with

Releases

Latest:5.0.2
registry.npmjs.org
0.x.x
Loading 0.x.x releases...
1.x.x
Loading 1.x.x releases...
2.x.x
Loading 2.x.x releases...
3.x.x
Loading 3.x.x releases...
4.x.x
Loading 4.x.x releases...
5.x.x
Loading 5.x.x releases...

Props

NameDescription
field*
object
Props for the input element, supplied by Formik .
form*
object
Form data including error and touched info, supplied by Formik .
label
string
Label text, HTML allowed.
type
string
type for the input field.
Options: "text", "email", "hidden"
placeholder
string
Placeholder text for the field
className
string
Optional className to add to the root element
theme
object
Controls the appearance of the text input. theme.background should be one of ["light", "dark", "brand"].