Skip to main content

TextField
component

Use a text field to allow merchants to enter or edit text. If you want to specify the kind of input, then use a formatted text field.

Anchor to textfieldTextField

Use a text field to allow merchants to input or modify multiline text.

Anchor to label
label
string
required

The content to use as the field label.

Anchor to action
action

A button under the text field to provide extra functionality.

Anchor to disabled
disabled
boolean

Whether the field can be modified.

Anchor to error
error
string

Indicates an error to the user. The field is given specific stylistic treatment to communicate problems that have to be resolved immediately.

Anchor to helpText
helpText
string

The label under the text field which provides guidance or instructions that assist users.

Anchor to maxLength
maxLength
number

The maximum number of characters allowed in the input field.

Anchor to onBlur
onBlur
() => void

The callback when focus is removed.

Anchor to onChange
onChange
(value: string) => void

The callback when the user has finished editing a field.

Anchor to onFocus
onFocus
() => void

The callback when input is focused.

Anchor to onInput
onInput
(value: string) => void

Callback when the user makes any changes in the field. As noted in the documentation for onChange, you must not use this to update value — use the onChange callback for that purpose. Use the onInput prop when you need to do something as soon as the user makes a change, like clearing validation errors that apply to the field as soon as the user begins making the necessary adjustments.

Anchor to placeholder
placeholder
string

A short hint that describes the expected value of the field.

Anchor to required
required
boolean

Whether the field needs a value.

Anchor to value
value
string

The current value for the field. Defaults to now. You should update this value in response to the onChange callback.

Was this section helpful?

Name Input

import React, {useState} from 'react';
import {
TextField,
Screen,
ScrollView,
Navigator,
reactExtension,
Text,
} from '@shopify/ui-extensions-react/point-of-sale';

const SmartGridModal = () => {
const [name, setName] = useState('');
return (
<Navigator>
<Screen name="TextField" title="Text Field Example">
<ScrollView>
<TextField
label="Name"
placeholder="Input your name here"
required={true}
value={name}
onChange={setName}
/>
<Text>{name ? `Hello ${name}!` : ''}</Text>
</ScrollView>
</Screen>
</Navigator>
);
};

export default reactExtension('pos.home.modal.render', () => (
<SmartGridModal />
));

Preview

Anchor to guidelinesGuidelines

  • When a merchant opens a new form, the first text field should be in a focused state.
  • If the merchant is actively focused in a text field, then the keyboard should come up and the label should move to the top of the field.
  • If focus goes away from the text field, then the keyboard should hide.
  • Text fields always take up the full screen width.
  • Text fields don’t change height. If text entered is longer than the width of the text field, then the oldest text on the left should be hidden to make room.
  • When it makes sense, provide autocomplete options (for example, entering an address).
Was this section helpful?

Anchor to content-guidelinesContent Guidelines

  • If a text field is required, then it should indicate Required.
  • Label titles should be brief and written in sentence case.
  • Use the same terms for similar label titles throughout the app.
Was this section helpful?