-
-
Notifications
You must be signed in to change notification settings - Fork 271
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
Support date/dateTime formatting #2589
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5565c09
Support date/dateTime formatting
Janpot d9df1de
Update tsconfig.json
Janpot 19fc95b
Update dateFormat.tsx
Janpot 56abbd3
reverse
Janpot f89373c
Merge branch 'master' into date-formatting
Janpot 510617d
Merge branch 'master' into date-formatting
Janpot 08f7cc3
comment
Janpot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| import { MenuItem, Stack, SxProps, TextField, styled } from '@mui/material'; | ||
| import * as React from 'react'; | ||
|
|
||
| export interface DateFormatPreset { | ||
| label?: string; | ||
| } | ||
|
|
||
| export type DateStyle = Intl.DateTimeFormatOptions['dateStyle']; | ||
| export type TimeStyle = Intl.DateTimeFormatOptions['timeStyle']; | ||
|
|
||
| const DEFAULT_DATE_STYLE: DateStyle = 'short'; | ||
| const DEFAULT_TIME_STYLE: TimeStyle = 'short'; | ||
|
|
||
| export const DATE_STYLES = new Map<DateStyle, DateFormatPreset>([ | ||
| ['short', { label: 'Short' }], | ||
| ['medium', { label: 'Medium' }], | ||
| ['long', { label: 'Long' }], | ||
| ['full', { label: 'Full' }], | ||
| ]); | ||
|
|
||
| export const TIME_STYLES = new Map<TimeStyle, DateFormatPreset>([ | ||
| ['short', { label: 'Short' }], | ||
| ['medium', { label: 'Medium' }], | ||
| ['long', { label: 'Long' }], | ||
| ['full', { label: 'Full' }], | ||
| ]); | ||
|
|
||
| const DATE_FORMATS = new Map<DateStyle, Intl.DateTimeFormat>( | ||
| (['short', 'medium', 'long', 'full'] as const).map((dateStyle) => [ | ||
| dateStyle, | ||
| new Intl.DateTimeFormat(undefined, { dateStyle }), | ||
| ]), | ||
| ); | ||
|
|
||
| const TIME_FORMATS = new Map<DateStyle, Intl.DateTimeFormat>( | ||
| (['short', 'medium', 'long', 'full'] as const).map((timeStyle) => [ | ||
| timeStyle, | ||
| new Intl.DateTimeFormat(undefined, { timeStyle }), | ||
| ]), | ||
| ); | ||
|
|
||
| // Constructing a demo date whether the time is 12h or 24h. | ||
| const DEMO_DATE = new Date(); | ||
| DEMO_DATE.setHours(13); | ||
| DEMO_DATE.setMinutes(28); | ||
| DEMO_DATE.setSeconds(54); | ||
|
|
||
| export interface DateFormat { | ||
| kind: 'shorthand'; | ||
| dateStyle?: DateStyle; | ||
| timeStyle?: TimeStyle; | ||
| } | ||
|
|
||
| export function createFormat(dateFormat?: DateFormat) { | ||
| if (!dateFormat) { | ||
| return new Intl.DateTimeFormat(undefined, {}); | ||
| } | ||
| switch (dateFormat.kind) { | ||
| case 'shorthand': { | ||
| const { dateStyle, timeStyle } = dateFormat; | ||
| return new Intl.DateTimeFormat(undefined, { dateStyle, timeStyle }); | ||
| } | ||
| default: { | ||
| return new Intl.DateTimeFormat(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const PrettyDateFormatRoot = styled('span')({}); | ||
|
|
||
| const DEFAULT_FORMAT = new Intl.DateTimeFormat(); | ||
|
|
||
| export interface FormattedDateProps { | ||
| format?: Intl.DateTimeFormat; | ||
| children: Date | number; | ||
| } | ||
|
|
||
| export function FormattedDate({ children, format = DEFAULT_FORMAT }: FormattedDateProps) { | ||
| const parts = React.useMemo(() => format.formatToParts(children), [children, format]); | ||
| return ( | ||
| <PrettyDateFormatRoot> | ||
| {parts.map((part, i) => ( | ||
| <span key={i} className={`date-token-type-${part.type}`}> | ||
| {part.value} | ||
| </span> | ||
| ))} | ||
| </PrettyDateFormatRoot> | ||
| ); | ||
| } | ||
|
|
||
| export interface DateFormatEditorProps { | ||
| value?: DateFormat; | ||
| onChange: (newValue?: DateFormat) => void; | ||
| disabled?: boolean; | ||
| sx?: SxProps; | ||
| label?: string; | ||
| disableTimeFormat?: boolean; | ||
| } | ||
|
|
||
| export function DateFormatEditor({ | ||
| label, | ||
| disabled, | ||
| value, | ||
| onChange, | ||
| sx, | ||
| disableTimeFormat, | ||
| }: DateFormatEditorProps) { | ||
| return ( | ||
| <Stack sx={sx} gap={1}> | ||
| <TextField | ||
| select | ||
| fullWidth | ||
| label={label ?? 'Date format'} | ||
| value={value?.dateStyle || DEFAULT_DATE_STYLE} | ||
| disabled={disabled} | ||
| onChange={(event) => { | ||
| let dateFormat: DateFormat | undefined; | ||
|
|
||
| if (event.target.value) { | ||
| dateFormat = { | ||
| kind: 'shorthand', | ||
| dateStyle: event.target.value as DateStyle, | ||
| timeStyle: disableTimeFormat ? undefined : value?.timeStyle || DEFAULT_TIME_STYLE, | ||
| }; | ||
| } | ||
|
|
||
| onChange(dateFormat); | ||
| }} | ||
| > | ||
| {Array.from(DATE_STYLES, ([type, preset]) => ( | ||
| <MenuItem key={type} value={type}> | ||
| {DATE_FORMATS.get(type)?.format(DEMO_DATE) || preset.label || type} | ||
| </MenuItem> | ||
| ))} | ||
| </TextField> | ||
| {disableTimeFormat ? null : ( | ||
| <TextField | ||
| select | ||
| fullWidth | ||
| label={label ?? 'Time format'} | ||
| value={value?.timeStyle || DEFAULT_TIME_STYLE} | ||
| disabled={disabled} | ||
| onChange={(event) => { | ||
| let dateFormat: DateFormat | undefined; | ||
|
|
||
| if (event.target.value) { | ||
| dateFormat = { | ||
| kind: 'shorthand', | ||
| dateStyle: value?.dateStyle || DEFAULT_DATE_STYLE, | ||
| timeStyle: event.target.value as TimeStyle, | ||
| }; | ||
| } | ||
|
|
||
| onChange(dateFormat); | ||
| }} | ||
| > | ||
| {Array.from(TIME_STYLES, ([type, preset]) => ( | ||
| <MenuItem key={type} value={type}> | ||
| {TIME_FORMATS.get(type)?.format(DEMO_DATE) || preset.label || type} | ||
| </MenuItem> | ||
| ))} | ||
| </TextField> | ||
| )} | ||
| </Stack> | ||
| ); | ||
| } | ||
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
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.
Could also be the current time? Anyway not important at all :D
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 want a time that always demonstrates whether it's 12h or 24h clock
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've added a comment