This field uses react-datepicker for the Admin panel component.
| 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 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. |
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-based hooks to control logic for this field. More |
access | Provide field-based access control to denote what users can see and do with this field's data. More |
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. See below for more detail. |
* An asterisk denotes that a property is required.
In addition to the default field 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 monthOnly. 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 dayOnly defaults to MMM d, yyy and monthOnly defaults to MM/yyyy. |
placeholder | Placeholder text for the field. |
monthsToShow | Number of months to display max is 2. Defaults to 1. |
minDate | Passed directly to react-datepicker. |
maxDate | Passed directly to react-datepicker. |
minTime | Passed directly to react-datepicker. |
maxTime | Passed directly to react-datepicker. |
timeIntervals | Passed directly to react-datepicker. Defaults to 30 minutes. |
timeFormat | Passed directly to react-datepicker. 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.
collections/ExampleCollection.ts