Skip to main content

DateField

Allow users to select a specific date with a date picker.

string

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

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.

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.

string

The default value for the field.

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.

string

Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.

This will also be exposed to screen reader users.

boolean

Disables the field, disallowing any interaction.

string

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

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.

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.

string

A unique identifier for the element.

string

Content to use as the field label.

Anchor to labelAccessibilityVisibility
labelAccessibilityVisibility
"visible" | "exclusive"

Changes the visibility of the component's label.

  • visible: the label is visible to all users.
  • exclusive: the label is visually hidden but remains in the accessibility tree.
string

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

string

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

boolean

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

boolean

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.

string

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

string

Displayed month in YYYY-MM format.

onViewChange is called when this value changes.

Defaults to defaultView.

Was this section helpful?

Learn more about registering events.

<'input'>
<'input'>
<'input'>
<'input'>
<typeof tagName> | null
<typeof tagName> | null
Was this section helpful?

Code

<s-date-field defaultView="2025-09" defaultValue="2025-09-01"></s-date-field>

Preview