Date Field

The Date Field saves a Date in the database and provides the Admin Panel with a customizable time picker interface.

This field is using the `react-datepicker` component for UI.

To add a Date Field, set the type to date in your Field Config:

1import type { Field } from 'payload'
2
3export const MyDateField: Field = {
4  // ...
5  type: 'date', 
6}

Config Options

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`label`	Text used as a field label in the Admin Panel or an object with keys for each language.
`index`	Build an index 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
`saveToJWT`	If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
`hooks`	Provide Field Hooks to control logic for this field. More details.
`access`	Provide Field Access Control to denote what users can see and do with this field's data. More details.
`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
`localized`	Enable localization for this field. Requires localization to be enabled in the Base config.
`required`	Require this field to have a value.
`admin`	Admin-specific configuration. More details.
`custom`	Extension point for adding custom data (e.g. for plugins)
`timezone` *	Set to `true` to enable timezone selection on this field. More details.
`typescriptSchema`	Override field type generation with providing a JSON schema
`virtual`	Provide `true` to disable field in the database. See Virtual Fields

* An asterisk denotes that a property is required.

Admin Options

To customize the appearance and behavior of the Date Field in the Admin Panel, you can use the admin option:

1import type { Field } from 'payload'
2
3export const MyDateField: Field = {
4  // ...
5  admin: { 
6    // ...
7  },
8}

The Date Field inherits all of the default options from the base Field Admin Config, plus the following additional options:

Property	Description
`placeholder`	Placeholder text for the field.
`date`	Pass options to customize date field appearance.
`date.displayFormat`	Format date to be shown in field cell.
`date.pickerAppearance` *	Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`.
`date.monthsToShow` *	Number of months to display max is 2. Defaults to 1.
`date.minDate` *	Min date value to allow.
`date.maxDate` *	Max date value to allow.
`date.minTime` *	Min time value to allow.
`date.maxTime` *	Max date value to allow.
`date.overrides` *	Pass any valid props directly to the react-datepicker
`date.timeIntervals` *	Time intervals to display. Defaults to 30 minutes.
`date.timeFormat` *	Determines time format. Defaults to `'h:mm aa'`.

* This property is passed directly to react-datepicker.

Display Format and Picker Appearance

These properties only affect how the date is displayed in the UI. The full date is always stored in the format YYYY-MM-DDTHH:mm:ss.SSSZ (e.g. 1999-01-01T8:00:00.000+05:00).

displayFormat determines how the date is presented in the field cell, you can pass any valid unicode date format.

pickerAppearance sets the appearance of the react datepicker, the options available are dayAndTime, dayOnly, timeOnly, and monthOnly. By default, the datepicker will display dayOnly.

When only pickerAppearance is set, an equivalent format will be rendered in the date field cell. To overwrite this format, set displayFormat.

Example

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
slug: 'example-collection',
fields: [
  {
    name: 'dateOnly',
    type: 'date',
    admin: {
      date: {
        pickerAppearance: 'dayOnly',
        displayFormat: 'd MMM yyy',
      },
    },
  },
  {
    name: 'timeOnly',
    type: 'date',
    admin: {
      date: {
        pickerAppearance: 'timeOnly',
        displayFormat: 'h:mm:ss a',
      },
    },
  },
  {
    name: 'monthOnly',
    type: 'date',
    admin: {
      date: {
        pickerAppearance: 'monthOnly',
        displayFormat: 'MMMM yyyy',
      },
    },
  },
],
37}

1import type React from 'react'
2import { DateTimeField } from '@payloadcms/ui'
3import type { DateFieldServerComponent } from 'payload'
4
5export const CustomDateFieldServer: DateFieldServerComponent = ({
6  clientField,
7  path,
8  schemaPath,
9  permissions,
10}) => {
11  return (
12    <DateTimeField
13      field={clientField}
14      path={path}
15      schemaPath={schemaPath}
16      permissions={permissions}
17    />
18  )
19}

Client Component

1'use client'
2import React from 'react'
3import { DateTimeField } from '@payloadcms/ui'
4import type { DateFieldClientComponent } from 'payload'
5
6export const CustomDateFieldClient: DateFieldClientComponent = (props) => {
7  return <DateTimeField {...props} />
8}

Label

Server Component

1import React from 'react'
2import { FieldLabel } from '@payloadcms/ui'
3import type { DateFieldLabelServerComponent } from 'payload'
4
5export const CustomDateFieldLabelServer: DateFieldLabelServerComponent = ({
6  clientField,
7  path,
8}) => {
9  return (
10    <FieldLabel
11      label={clientField?.label || clientField?.name}
12      path={path}
13      required={clientField?.required}
14    />
15  )
16}

Client Component

1'use client'
2import React from 'react'
3import { FieldLabel } from '@payloadcms/ui'
4import type { DateFieldLabelClientComponent } from 'payload'
5
6export const CustomDateFieldLabelClient: DateFieldLabelClientComponent = ({
7  field,
8  path,
9}) => {
10  return (
11    <FieldLabel
12      label={field?.label || field?.name}
13      path={path}
14      required={field?.required}
15    />
16  )
17}

Timezones

To enable timezone selection on a Date field, set the timezone property to true:

1{
2  name: 'date',
3  type: 'date',
4  timezone: true,
5}

This will add a dropdown to the date picker that allows users to select a timezone. The selected timezone will be saved in the database along with the date in a new column named date_tz.

You can customise the available list of timezones in the global admin config.

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Date Field

Config Options

Admin Options

Display Format and Picker Appearance

Example

Custom Components

Field

Server Component

Client Component

Label

Server Component

Client Component

Timezones

Email Field