CMS Design System

Date field (single-input) provides date entry, using a text field, in a single input.

`<SingleInputDateField>`

Code snippet

Props

React Properties Documentation
Name	Type	Description
`name`required	`string`	The `input` field's `name` attribute
`onBlur`	`(event: React.FocusEvent<HTMLInputElement>) => any`	Called anytime any date input is blurred
`onChange`required	`(updatedValue: string, formattedValue: string) => any`	Called anytime any date input is changed. This function is called with two arguments. The first argument should be used to update whatever state your application uses to supply back to this component's `value` prop in a controlled component pattern.
`value`	`string`	Sets the input's `value`. Use in combination with an `onChange` handler to implement a controlled component pattern. This component expects the `value` to match whatever string the user types (i.e., the first argument provided to your `onChange` handler).
`defaultMonth`	`Date`	The initial month to show in the calendar picker. If not provided, defaults to the month of the currently selected date.
`fromDate`	`Date`	Earliest day to start month navigation in the calendar picker. (This does not restrict dates entered manually.)
`fromMonth`	`Date`	Earliest month to start month navigation in the calendar picker. (This does not restrict dates entered manually.)
`fromYear`	`number`	Earliest year to start month navigation in the calendar picker. (This does not restrict dates entered manually.)
`toDate`	`Date`	Latest day to end month navigation in the calendar picker. (This does not restrict dates entered manually.)
`toMonth`	`Date`	Latest month to end month navigation in the calendar picker. (This does not restrict dates entered manually.)
`toYear`	`number`	Latest year to end month navigation in the calendar picker. (This does not restrict dates entered manually.)

Guidance

When to use

Use the date input when your user flow does not require separate fields for month, day, and year.
Use the date input for most dates, particularly memorable dates like date of birth, marriage date, health coverage start or end dates, or income start date.

When to consider alternatives

Don't use if users are entering a date within the last year or a future date. Instead, use the date picker.

Usage

Allow users to have flexibility in entering the date, such as allowing one-digit numbers with or without "0" prior to the number, or entering a date with or without slashes to separate month, day, and year.

Example: "1" as well as "01" for a month or day.
Example: "05/01/2022" as well as "05012022".

Accessibility

These text fields should follow the accessibility guidelines for all text inputs.
Users will be able to enter a variety of date formats that automatically format to the correct date format of MM/DD/YYYY. This change happens once the form field loses focus. For example, a user enters a date as "4122020" and it changes to "04/01/2020" once focus leaves the date input.

Customization

The following Sass variables can be overridden to customize Input/Form components:

Variable	Default Core Theme Value
`$text-input__line-height`	`1.3`
`$text-input__background-color--disabled`	`$color-border`
`$text-input__border-width`	`2px`
`$text-input__border-color`	`$color-base`
`$text-input__border-color--disabled`	`$color-gray-light`
`$text-input__border-color--error`	`$color-error`
`$text-input__border-color--error--inverse`	`$color-error-light`
`$text-input__border-color--inverse`	`$color-black`
`$text-input__border-color--success`	`$color-green-light`
`$text-input__color`	`$color-base`
`$text-input__padding`	`8px`
`$text-input__border-radius`	`3px`

Form components

Variable	Default Core Theme Value
`$form-label__color--inverse`	`$color-white`
`$form__max-width`	`460px`
`$form__max-width--small`	`6em`
`$form__max-width--medium`	`12em`
`$form-hint__color`	`$color-gray`
`$form-hint__color--inverse`	`$color-muted-inverse`
`$form-error__color`	`$color-error`
`$form-error__color--inverse`	`$color-error-light`

<SingleInputDateField>