Skip to main content

Date field

The date field component captures date input with a consistent interface for date selection and proper validation. Use it to collect date information in forms, scheduling interfaces, or data entry workflows.

The component supports manual text entry. For visual calendar-based selection, consider using date picker.

Support
Targets (29)

Supported targets

  • purchase.checkout.actions.render-before
  • purchase.checkout.block.render
  • purchase.checkout.cart-line-item.render-after
  • purchase.checkout.cart-line-list.render-after
  • purchase.checkout.contact.render-after
  • purchase.checkout.delivery-address.render-after
  • purchase.checkout.delivery-address.render-before
  • purchase.checkout.footer.render-after
  • purchase.checkout.header.render-after
  • purchase.checkout.payment-method-list.render-after
  • purchase.checkout.payment-method-list.render-before
  • purchase.checkout.pickup-location-list.render-after
  • purchase.checkout.pickup-location-list.render-before
  • purchase.checkout.pickup-location-option-item.render-after
  • purchase.checkout.pickup-point-list.render-after
  • purchase.checkout.pickup-point-list.render-before
  • purchase.checkout.reductions.render-after
  • purchase.checkout.reductions.render-before
  • purchase.checkout.shipping-option-item.details.render
  • purchase.checkout.shipping-option-item.render-after
  • purchase.checkout.shipping-option-list.render-after
  • purchase.checkout.shipping-option-list.render-before
  • purchase.thank-you.announcement.render
  • purchase.thank-you.block.render
  • purchase.thank-you.cart-line-item.render-after
  • purchase.thank-you.cart-line-list.render-after
  • purchase.thank-you.customer-information.render-after
  • purchase.thank-you.footer.render-after
  • purchase.thank-you.header.render-after

Anchor to propertiesProperties

Anchor to allow
allow
string
Default: ""

Dates that can be selected.

A comma-separated list of dates, date ranges. Whitespace is allowed after commas.

The default '' allows all dates.

  • Dates in YYYY-MM-DD format allow a single date.
  • Dates in YYYY-MM format allow a whole month.
  • Dates in YYYY format allow a whole year.
  • Ranges are expressed as start--end. - Ranges are inclusive.
    • If either start or end is omitted, the range is unbounded in that direction.
    • If parts of the date are omitted for start, they are assumed to be the minimum possible value. So 2024-- is equivalent to 2024-01-01--.
    • If parts of the date are omitted for end, they are assumed to be the maximum possible value. So --2024 is equivalent to --2024-12-31.
    • Whitespace is allowed either side of --.
Anchor to allowDays
allowDays
string
Default: ""

Days of the week that can be selected. These intersect with the result of allow and disallow.

A comma-separated list of days. Whitespace is allowed after commas.

The default '' has no effect on the result of allow and disallow.

Days are sunday, monday, tuesday, wednesday, thursday, friday, saturday.

Anchor to autocomplete
autocomplete
AutocompleteField | `${} ${AutocompleteField}` | `${} ${AutocompleteField}` | `${} ${} ${AutocompleteField}` | "on" | "off"
Default: 'on' for everything else

A hint as to the intended content of the field.

When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.

When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.

Anchor to defaultValue
defaultValue
string

The default value for the field.

Anchor to defaultView
defaultView
string

Default month to display in YYYY-MM format.

This value is used until view is set, either directly or as a result of user interaction.

Defaults to the current month in the user's locale.

Anchor to disabled
disabled
boolean
Default: false

Disables the field, disallowing any interaction.

Anchor to disallow
disallow
string
Default: ""

Dates that cannot be selected. These subtract from allow.

A comma-separated list of dates, date ranges. Whitespace is allowed after commas.

The default '' has no effect on allow.

  • Dates in YYYY-MM-DD format disallow a single date.
  • Dates in YYYY-MM format disallow a whole month.
  • Dates in YYYY format disallow a whole year.
  • Ranges are expressed as start--end. - Ranges are inclusive.
    • If either start or end is omitted, the range is unbounded in that direction.
    • If parts of the date are omitted for start, they are assumed to be the minimum possible value. So 2024-- is equivalent to 2024-01-01--.
    • If parts of the date are omitted for end, they are assumed to be the maximum possible value. So --2024 is equivalent to --2024-12-31.
    • Whitespace is allowed either side of --.
Anchor to disallowDays
disallowDays
string
Default: ""

Days of the week that cannot be selected. This subtracts from allowDays, and intersects with the result of allow and disallow.

A comma-separated list of days. Whitespace is allowed after commas.

The default '' has no effect on allowDays.

Days are sunday, monday, tuesday, wednesday, thursday, friday, saturday.

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 element.

Anchor to label
label
string

Content to use as the field label.

Anchor to name
name
string

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

Anchor to readOnly
readOnly
boolean
Default: false

The field cannot be edited by the user. It is focusable will be announced by screen readers.

Anchor to required
required
boolean
Default: false

Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.

Anchor to value
value
string

The current value for the field. If omitted, the field will be empty.

Anchor to view
view
string

Displayed month in YYYY-MM format.

onViewChange is called when this value changes.

Defaults to defaultView.

Anchor to eventsEvents

Learn more about registering events.

Anchor to blur
blur
<typeof tagName>

Callback when the element loses focus.

Anchor to change
change
<typeof tagName>

Callback when the user has finished editing a field, e.g. once they have blurred the field.

Anchor to focus
focus
<typeof tagName>

Callback when the element receives focus.

Anchor to input
input
<typeof tagName>

Callback when the user makes any changes in the field.

Anchor to invalid
invalid
<typeof tagName>

Callback when the user enters an invalid date.

Anchor to viewChange
viewChange
<typeof tagName>

Callback when the view changes.

Examples
<s-date-field label="Pickup date" defaultValue="2025-10-01"></s-date-field>

Preview

Was this page helpful?