Use a date field to get a date input from a customer.
import {render, DateField} from '@shopify/checkout-ui-extensions-react';
render('Checkout::Dynamic::Render', () => import {extend, DateField} from '@shopify/checkout-ui-extensions';
extend('Checkout::Dynamic::Render', (root) => {
const datefield = root.createComponent(DateField, {
label: 'Select a date',
});
root.appendChild(datefield);
});
Callback when the field has an invalid date. This callback will be called, if 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 buyer 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.
A unique identifier for the field. When no `id` is set, a globally unique value will be used instead.
An identifier for the field that is unique within the nearest containing `Form` component.
Content to use as the field label. This value is also used as the placeholder when the field is empty.
The current value for the field. If omitted, the field will be empty. You should update this value in response to the `onChange` callback.
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
Whether the field is read-only.
Callback when input is focused.
Callback when focus is removed.
Callback when the buyer has **finished editing** a 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 buyer edits the field, its state is controlled by the component. Once the buyer 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](https://reactjs.org/docs/forms.html#controlled-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 buyer 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.
Callback when the user makes any changes in the field. 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 buyer 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.
[Controlled](https://reactjs.org/docs/forms.html#controlled-components) year and month to display. Use in combination with `onYearMonthChange`. Makes year/month navigation controlled.
Default [uncontrolled](https://reactjs.org/docs/forms.html#controlled-components) year and month to display. Ignored when year/month navigation is controlled.
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.
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.
{year: number; month: number} | YearMonthString
A year/month string using the simplified ISO 8601 format (`YYYY-MM`)
string
DateString | DateRange | DayString
string
First day (inclusive) of the selected range
Last day (inclusive) of the selected range
keyof typeof Day