Post fields: move date fields from edit-site to fields package
#66938
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { __, sprintf } from '@wordpress/i18n'; | ||
| import { createInterpolateElement } from '@wordpress/element'; | ||
| import { dateI18n, getDate, getSettings } from '@wordpress/date'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { BasePost } from '../../types'; | ||
|
|
||
| const getFormattedDate = ( dateToDisplay: string | null ) => | ||
| dateI18n( | ||
| getSettings().formats.datetimeAbbreviated, | ||
| getDate( dateToDisplay ) | ||
| ); | ||
|
|
||
| const DateView = ( { item }: { item: BasePost } ) => { | ||
| const isDraftOrPrivate = [ 'draft', 'private' ].includes( | ||
| item.status ?? '' | ||
| ); | ||
| if ( isDraftOrPrivate ) { | ||
| return createInterpolateElement( | ||
| sprintf( | ||
| /* translators: %s: page creation or modification date. */ | ||
| __( '<span>Modified: <time>%s</time></span>' ), | ||
| getFormattedDate( item.date ?? null ) | ||
| ), | ||
| { | ||
| span: <span />, | ||
| time: <time />, | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| const isScheduled = item.status === 'future'; | ||
| if ( isScheduled ) { | ||
| return createInterpolateElement( | ||
| sprintf( | ||
| /* translators: %s: page creation date */ | ||
| __( '<span>Scheduled: <time>%s</time></span>' ), | ||
| getFormattedDate( item.date ?? null ) | ||
| ), | ||
| { | ||
| span: <span />, | ||
| time: <time />, | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| const isPublished = item.status === 'publish'; | ||
| if ( isPublished ) { | ||
| return createInterpolateElement( | ||
| sprintf( | ||
| /* translators: %s: page creation time */ | ||
| __( '<span>Published: <time>%s</time></span>' ), | ||
| getFormattedDate( item.date ?? null ) | ||
| ), | ||
| { | ||
| span: <span />, | ||
| time: <time />, | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| // Pending posts show the modified date if it's newer. | ||
| const dateToDisplay = | ||
| getDate( item.modified ?? null ) > getDate( item.date ?? null ) | ||
| ? item.modified | ||
| : item.date; | ||
|
|
||
| const isPending = item.status === 'pending'; | ||
| if ( isPending ) { | ||
| return createInterpolateElement( | ||
| sprintf( | ||
| /* translators: %s: page creation or modification date. */ | ||
| __( '<span>Modified: <time>%s</time></span>' ), | ||
| getFormattedDate( dateToDisplay ?? null ) | ||
| ), | ||
| { | ||
| span: <span />, | ||
| time: <time />, | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| // Unknow status. | ||
| return <time>{ getFormattedDate( item.date ?? null ) }</time>; | ||
| }; | ||
|
|
||
| export default DateView; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import type { Field } from '@wordpress/dataviews'; | ||
| import { __ } from '@wordpress/i18n'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { BasePost } from '../../types'; | ||
| import DateView from './date-view'; | ||
|
|
||
| const dateField: Field< BasePost > = { | ||
| id: 'date', | ||
| type: 'datetime', | ||
| label: __( 'Date' ), | ||
| render: DateView, | ||
| }; | ||
|
|
||
| /** | ||
| * Date field for BasePost. | ||
| */ | ||
| export default dateField; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,24 +8,25 @@ | |
| }, | ||
| "references": [ | ||
| { "path": "../api-fetch" }, | ||
| { "path": "../blob" }, | ||
| { "path": "../components" }, | ||
| { "path": "../compose" }, | ||
| { "path": "../core-data" }, | ||
| { "path": "../data" }, | ||
| { "path": "../dataviews" }, | ||
| { "path": "../date" }, | ||
|
There was a problem hiding this comment. Sorted alphabetically, like the
|
||
| { "path": "../element" }, | ||
| { "path": "../hooks" }, | ||
| { "path": "../html-entities" }, | ||
| { "path": "../i18n" }, | ||
| { "path": "../icons" }, | ||
| { "path": "../media-utils" }, | ||
| { "path": "../notices" }, | ||
| { "path": "../primitives" }, | ||
| { "path": "../private-apis" }, | ||
| { "path": "../router" }, | ||
| { "path": "../url" }, | ||
| { "path": "../warning" } | ||
| ], | ||
| "include": [ "src" ] | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One interesting thing from migrating this to TypeScript is that it forces you to pass the last parameter. Despite what the docs say, there's no default value and cannot be undefined.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this can be solved by slightly changing the type definition of the function and making the argument optional
=somethingrather thansomething | undefinedThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I pushed 9e44b6f and 012a507
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reverted the default parameter and modified the JSDoc instead at 544bf3e