tabshift/payload
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: updates date field docs

Browse Source
This commit is contained in:
PatrikKozak
2023-04-05 21:19:26 -04:00
parent 299ae4fce5
commit 67098f7a3e
1 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
docs/fields/date.mdx
View File

@@ -18,7 +18,7 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic
| Option | Description | | Option | Description |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. |
| **`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. | | **`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) | | **`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. | | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
@@ -28,7 +28,7 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic
| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`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. | | **`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. | | **`required`** | Require this field to have a value. |
| **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). |
_\* An asterisk denotes that a property is required._ _\* An asterisk denotes that a property is required._
@@ -36,19 +36,19 @@ _\* An asterisk denotes that a property is required._
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. 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.
| Property | Option | Description | | Property | Description |
| ---------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | ------------------------------------------------------------------------------------------- |
| **`placeholder`** | | Placeholder text for the field. | | **`placeholder`** | Placeholder text for the field. |
| **`date`** | | Pass options to customize date field appearance. | | **`date`** | Pass options to customize date field appearance. |
| | **`displayFormat`** | Format date to be shown in field **cell**. | | **`date.displayFormat`** | Format date to be shown in field **cell**. |
| | **`pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. | | **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. |
| | **`monthsToShow`** \* | Number of months to display max is 2. Defaults to 1. | | **`date.monthsToShow`** \* | Number of months to display max is 2. Defaults to 1. |
| | **`minDate`** \* | Min date value to allow. | | **`date.minDate`** \* | Min date value to allow. |
| | **`maxDate`** \* | Max date value to allow. | | **`date.maxDate`** \* | Max date value to allow. |
| | **`minTime`** \* | Min time value to allow. | | **`date.minTime`** \* | Min time value to allow. |
| | **`maxTime`** \* | Max date value to allow. | | **`date.maxTime`** \* | Max date value to allow. |
| | **`timeIntervals`** \* | Time intervals to display. Defaults to 30 minutes. | | **`date.timeIntervals`** \* | Time intervals to display. Defaults to 30 minutes. |
| | **`timeFormat`** \* | Determines time format. Defaults to `'h:mm aa'`. | | **`date.timeFormat`** \* | Determines time format. Defaults to `'h:mm aa'`. |
_\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._ _\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._
@@ -67,41 +67,41 @@ When only `pickerAppearance`, an equivalent format will be rendered in the date
`collections/ExampleCollection.ts` `collections/ExampleCollection.ts`
```ts ```ts
import { CollectionConfig } from 'payload/types'; import { CollectionConfig } from "payload/types";
const ExampleCollection: CollectionConfig = { const ExampleCollection: CollectionConfig = {
slug: 'example-collection', slug: "example-collection",
fields: [ fields: [
{ {
name: 'dateOnly', name: "dateOnly",
type: 'date', type: "date",
admin: { admin: {
date: { date: {
pickerAppearance: 'dayOnly', pickerAppearance: "dayOnly",
displayFormat: 'd MMM yyy', displayFormat: "d MMM yyy",
}, },
}, },
}, },
{ {
name: 'timeOnly', name: "timeOnly",
type: 'date', type: "date",
admin: { admin: {
date: { date: {
pickerAppearance: 'timeOnly', pickerAppearance: "timeOnly",
displayFormat: 'h:mm:ss a', displayFormat: "h:mm:ss a",
}, },
}, },
}, },
{ {
name: 'monthOnly', name: "monthOnly",
type: 'date', type: "date",
admin: { admin: {
date: { date: {
pickerAppearance: 'monthOnly', pickerAppearance: "monthOnly",
displayFormat: 'MMMM yyyy', displayFormat: "MMMM yyyy",
}, },
}, },
}, },
] ],
}; };
``` ```