TextField

A field for editing a line of text.

import { TextField } from '@satinhq/kit'

Example

import { useState } from 'react'
import { List, Screen, Section, TextField } from '@satinhq/kit'

function Example() {
  const [text, setText] = useState('')

  return (
    <Screen>
      <List id="example">
        <Section>
          <TextField label="Name" value={text} onChange={setText} />
        </Section>
      </List>
    </Screen>
  )
}

9:41

Click the Name field and type. Try the system keyboard on a device.

Bind the text

Keep the text in React state. Pass the string to value and its setter to onChange.

Name the field

Use label for its accessible name. A prompt supplies placeholder text when the field is empty.

Choose keyboard and Return behavior

Set kind to describe the value, such as name, email or decimal. submitLabel supplies the Return-key hint; onSubmit handles Return in a single-line field.

API

Scroll horizontally to read every column.

Prop	Type	Description
label	string	The accessible name.
value	string	The current text.
onChange	(value: string) => void	Receives edited text.
prompt	string	Optional placeholder.
kind	TextFieldKind	Keyboard and autofill intent.
submitLabel	SubmitLabel	Return-key hint.
onSubmit	() => void	Single-line Return action.

Related: Quick start, List, Screen.

:::