-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add timezone support on date fields #10896
Open
paulpopus
wants to merge
21
commits into
main
Choose a base branch
from
feat/timezone-support-on-date-fields
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+9,281
−2,979
Conversation
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
paulpopus
requested review from
denolfe,
jmikrut and
DanRibbens
as code owners
January 31, 2025 01:39
jacobsfletch
requested changes
Jan 31, 2025
jacobsfletch
requested changes
Jan 31, 2025
packages/payload/src/fields/baseFields/timezone/timezoneOptions.ts
Outdated
Show resolved
Hide resolved
jacobsfletch
previously approved these changes
Feb 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds support for timezone selection on date fields.
Summary
timezone
config option on date fieldstimezone.supportedTimezones
in global admin config to allow customisation of available timezonestimezone.defaultTimezone
sets the default selectionConfiguration
All date fields now accept
timezone: true
to enable this feature, which will inject a new field into the configuration using the date field's name to construct the name for the timezone column. SopublishingDate
will havepublishingDate_timezone
as an accompanying column. This new field is inserted during config sanitisation.Example:
In the future we can turn this to accept a config object as well if needed.
Dates continue to be stored in UTC, this will help maintain dates without needing a migration and it makes it easier for data to be manipulated as needed. Mongodb also has a restriction around storing dates only as UTC.
All timezones are stored by their IANA names so it's compatible with browser APIs.
We handle timezone calculations via a new package
@date-fns/tz
which we will be using in the future for handling timezone aware scheduled publishing/unpublishing and more.UI
Dark mode
Light mode
Left to do:
Timezone:
label