Choose a version:

DateField

This is a form field that lets users select a date using the DatePicker component.

Anchor to datefieldpropsDateFieldProps

Anchor to label label string required: Content to use as the field label.
Anchor to defaultYearMonth defaultYearMonth {year: ; month: } |: 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: Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
Anchor to id id string: A unique identifier for the field.
Anchor to name name string: An identifier for the field that is unique within the nearest containing Form component.
Anchor to onBlur onBlur () => void: Callback when focus is removed.
Anchor to onChange onChange (value: string) => void: Callback when the user has finished editing a field. Unlike onChange callbacks you may be familiar with from 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: 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.

This callback is called with the current value of the field.
Anchor to onYearMonthChange onYearMonthChange (yearMonth: { year: number; month: number; }) => void: A callback that is run whenever the month is changed. 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.
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 {year: ; month: } |: Controlled year and month to display. Use in combination with onYearMonthChange. Makes year/month navigation controlled.

Year

number

Month

Month in 1-12 range

number

YearMonthString

A year/month string using the simplified ISO 8601 format (`YYYY-MM`)

string

Disabled

DateString | Range | Day

DateString

A date string using the simplified ISO 8601 format (`YYYY-MM-DD`)

string

Range

end
Last day (inclusive) of the selected range
```
DateString
```
start
First day (inclusive) of the selected range
```
DateString
```

export interface Range {
  /**
   * First day (inclusive) of the selected range
   */
  start?: DateString;

  /**
   * Last day (inclusive) of the selected range
   */
  end?: DateString;
}

Day

'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday'

Was this section helpful?

Add a single-date DateField

import React, {useState} from 'react';

import {

render,

DateField,

} from '@shopify/ui-extensions-react/admin';

render('Playground', () => <App />);

function App() {

const [value, setValue] =

useState('2023-11-08');

return (

<DateField

label="DateField"

value={value}

onChange={setValue}

);

}

Examples

Add a single-date DateField

React

import React, {useState} from 'react';
import {
  render,
  DateField,
} from '@shopify/ui-extensions-react/admin';

render('Playground', () => <App />);

function App() {
  const [value, setValue] =
    useState('2023-11-08');
  return (
    <DateField
      label="DateField"
      value={value}
      onChange={setValue}
    />
  );
}

JS

import {extend, DateField} from '@shopify/ui-extensions/admin';

extend('Playground', (root) => {
  const dateField = root.createComponent(
    DateField,
    {
      label: 'Date',
      value: '2023-11-08',
    },
    'DateField',
  );

  root.appendChild(dateField);
});

DateField

Anchor to datefieldpropsDateFieldProps

Year

Month

YearMonthString

Disabled

DateString

Range

Day

Examples

Add a single-date DateField

React

JS

Preview