Payload

Date Field

This field uses react-datepicker for the Admin panel component.

Config

OptionDescription
name *To be used as the property name when stored and retrieved from the database.
labelUsed as a field label in the Admin panel and to name the generated GraphQL type.
indexBuild a MongoDB 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.
validateProvide a custom validation function that will be executed on both the Admin panel and the backend. More
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide field-based hooks to control logic for this field. More
accessProvide field-based access control to denote what users can see and do with this field's data. More
hiddenRestrict 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.
defaultValueProvide data to be used for this field's default value.
localizedEnable localization for this field. Requires localization to be enabled in the Base config.
requiredRequire this field to have a value.
adminAdmin-specific configuration. See below for more detail.

* An asterisk denotes that a property is required.

Admin config

In addition to the default field admin config, you can customize all of the options that react-datepicker provisions for via the date property.

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.

Check out the react-datepicker docs for more info.

Example

collections/ExampleCollection.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 `react-datepicker` options are supported
          pickerAppearance: 'timeOnly',
        }
      }
    }
  ]
}
Next

Email Field

On this page
Edit on GitHub