- Docs
- components
- DateField
DateField
A date field allows users to enter and edit date and time values using a keyboard. Each part of a date value is displayed in an individually editable segment.
Installation
A date field can be built using <input type="date">
, but this is very limited in functionality, lacking in internationalization capabilities, inconsistent between browsers, and difficult to style. DateField helps achieve accessible and international date and time fields that can be styled as needed.
Composed Components
A DateField uses the following components, which may also be used standalone or reused in other components.
Label
A label provides context for an element.
Reusable Wrapper - Example
If you will use a DateField in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.
The installed file includes a reusable wrapper JollyDateField
. This wrapper serves as an excellent starting point for use throughout your codebase.
The JollyDateField
component extends the props of React Aria DateField and adds:
Prop | Type | Default | Description |
---|---|---|---|
label | string | undefined | undefined | Label for the date field |
description | string | undefined | undefined | Description text for the date field |
errorMessage | string | ((validation: AriaValidationResult) => string) | undefined | undefined | Error message to display or function to generate it |
You can copy this wrapper and create variations as needed for different use cases in your application. This approach promotes consistency while still allowing for flexibility in implementation.