Skip to main content
Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

DateField

Use the DateField component to get a date input from a buyer.

Support
Targets (50)

Supported targets

Anchor to DateFieldPropsDateFieldProps

Anchor to label
label
string
required

The text displayed as the field label, which identifies the purpose of the field to users. This value is also used as the placeholder when the field is empty.

Anchor to defaultYearMonth
defaultYearMonth

Default uncontrolled year and month to display. Ignored when year/month navigation is controlled.

Anchor to disabled
disabled
[] | boolean

Disabled dates, days, and/or ranges, or the date picker. Unbound range disables all dates either from start date or to end date. true disables the date picker.

Anchor to error
error
string

An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators.

Anchor to id
id
string

A unique identifier for the field. When no id is set, a globally unique value will be used instead.

Anchor to name
name
string

An identifier for the field that is unique within the nearest containing Form component.

Anchor to onBlur
onBlur
() => void

A callback fired when the text field loses focus.

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

A callback fired when the user has finished editing the field, such as when they blur the field. Unlike onChange callbacks you may be familiar with from Polaris or other React component libraries, this callback is not run on every change to the input. Text fields are “partially controlled” components, which means that while the user edits the field, its state is controlled by the component. Once the user has signalled that they have finished editing the field (typically, by blurring the field), onChange is called if the input actually changed from the most recent value property. At that point, you are expected to store this “committed value” in state, and reflect it in the text field’s value property.

This state management model is important given how UI Extensions are rendered. UI Extension components run on a separate thread from the UI, so they can’t respond to input synchronously. A pattern popularized by controlled React components is to have the component be the source of truth for the input value, and update the value on every user input. The delay in responding to events from a UI extension is only a few milliseconds, but attempting to strictly store state with this delay can cause issues if a user types quickly, or if the user is using a lower-powered device. Having the UI thread take ownership for “in progress” input, and only synchronizing when the user is finished with a field, avoids this risk.

It can still sometimes be useful to be notified when the user makes any input in the field. If you need this capability, you can use the onInput prop. However, never use that property to create tightly controlled state for the value.

This callback is called with the current value of the field. If the value of a field is the same as the current value prop provided to the field, the onChange callback will not be run.

Anchor to onFocus
onFocus
() => void

A callback fired when the text field receives focus.

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

A callback fired when the user makes any changes in the field, such as typing a character. As noted in the documentation for onChange, you must not use this to update state — 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.

This callback is called with the current value of the field.

Anchor to onInvalid
onInvalid
() => void

A callback fired when the date field contains an invalid or disabled date after the user finishes editing. This callback is invoked when the date typed is invalid or disabled.

Dates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:

  • 2021-02-31: February doesn’t have 31 days
  • 2021-02-00: The day can’t be 00

Dates and ranges specified in the disabled property are considered disabled dates. If the disabled property is 2021-06-14, and the user types 2021-06-14, this callback will be called as this date is disabled.

Note that this will be called only when the user finishes editing the date, after the onChange callback. The field is not validated on every change to the input. Once the user has signalled that they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.

Anchor to onYearMonthChange
onYearMonthChange
(yearMonth: { year: number; month: number; }) => void

A callback fired when the displayed year and month change. This callback is called with an object indicating the year/month the UI should change to. When year/month navigation is controlled you must store these values in state and reflect it back in the yearMonth prop.

Anchor to readonly
readonly
boolean

Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.

Anchor to value
value
T

The current value for the field. If omitted, the field will be empty. You should update this value in response to the onChange callback.

Anchor to yearMonth
yearMonth

Controlled year and month to display. Use in combination with onYearMonthChange. Makes year/month navigation controlled.

Anchor to ExamplesExamples

Anchor to Basic DateFieldBasic DateField

Basic DateField

Example

Basic DateField

import {
reactExtension,
DateField,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);

function Extension() {
return <DateField label="Select a date" />;
}
import {extension, DateField} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
const datefield = root.createComponent(DateField, {
label: 'Select a date',
});

root.appendChild(datefield);
});

Anchor to Best practicesBest practices

  • Set meaningful defaults: Pre-fill when you already know a sensible date to reduce manual entry.
  • Restrict invalid dates: Use the disabled prop with dates, ranges, or day rules to prevent buyers from choosing unavailable dates.
  • Pair with DatePicker: For selection that benefits from calendar context, use the DatePicker component alongside or instead of the DateField component.

Anchor to LimitationsLimitations

  • Date values use YYYY-MM-DD format. Locale-specific formats aren't supported for the value buyers enter.
  • Unavailable dates are configured through the disabled prop. See the API reference for supported shapes.
Was this page helpful?