80 lines
6.6 KiB
Plaintext
80 lines
6.6 KiB
Plaintext
---
|
|
title: Date Field
|
|
label: Date
|
|
order: 60
|
|
desc: The Date field type stores a Date in the database. Learn how to use and customize the Date field, see examples and options.
|
|
keywords: date, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
|
|
---
|
|
|
|
<Banner>
|
|
The Date field type saves a Date in the database and provides the Admin panel
|
|
with a customizable time picker interface.
|
|
</Banner>
|
|
|
|
This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepicker) for the Admin panel component.
|
|
|
|
### Config
|
|
|
|
| Option | Description |
|
|
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **`name`** \* | To be used as the property name when stored and retrieved from the database. |
|
|
| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. |
|
|
| **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
|
|
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
|
|
| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
|
|
| **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
|
|
| **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |
|
|
| **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. |
|
|
| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) |
|
|
| **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
|
|
| **`required`** | Require this field to have a value. |
|
|
| **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). |
|
|
|
|
_\* An asterisk denotes that a property is required._
|
|
|
|
### Admin Config
|
|
|
|
In addition to the default [field admin config](/docs/fields/overview#admin-config), you can customize the following fields that will adjust how the component displays in the admin panel via the `date` property.
|
|
|
|
| Option | Description |
|
|
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **`pickerAppearance`** | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly`. Defaults to `dayAndTime`. |
|
|
| **`displayFormat`** | Determines how the date is presented. dayAndTime default to `MMM d, yyy h:mm a` timeOnly defaults to `h:mm a` and dayOnly defaults to `MMM d, yyy`. |
|
|
| **`placeholder`** | Placeholder text for the field. |
|
|
| **`monthsToShow`** | Number of months to display max is 2. Defaults to 1. |
|
|
| **`minDate`** | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). |
|
|
| **`maxDate`** | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). |
|
|
| **`minTime`** | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). |
|
|
| **`maxTime`** | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). |
|
|
| **`timeIntervals`** | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). Defaults to 30 minutes. |
|
|
| **`timeFormat`** | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). Defaults to `'h:mm aa'`. |
|
|
|
|
_\* An asterisk denotes that a property is required._
|
|
|
|
Common use cases for customizing the `date` property are to restrict your field to only show time or day input—but lots more can be done.
|
|
|
|
### Example
|
|
|
|
`collections/ExampleCollection.js`
|
|
|
|
```js
|
|
{
|
|
slug: 'example-collection',
|
|
fields: [
|
|
{
|
|
name: 'time', // required
|
|
type: 'date', // required
|
|
label: 'Event Start Time',
|
|
defaultValue: '1988-11-05T8:00:00.000+05:00',
|
|
admin: {
|
|
date: {
|
|
// All config options above should be placed here
|
|
pickerAppearance: 'timeOnly',
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
|
|
```
|