feat(datetime): formatOptions for time button and header #29009
Conversation
revert example
Co-authored by: Sean Perkins <[email protected]>
github-actions
bot
added
package: core
mapsandapps
requested review from
liamdebeasi,
averyjohnston,
sean-perkins,
thetaPC and
a team
as code owners
| /** | ||
| * Formatting options, separated by date and time. | ||
| */ | ||
| @Prop() formatOptions?: DatetimeFormatOptions; |
There was a problem hiding this comment.
Optional: It would be cool to have a test HTML page to mess around with this ready to go. Maybe something with a text box that lets you enter a value for formatOptions dynamically, and a button to update the datetime with what you've entered? Definitely only do this if you have spare time though.
There was a problem hiding this comment.
It would be great to also improve the JSDoc comment here. This is the information that will show in the docs and intellisense.
Would be good to include what format it requires and maybe a link out to MDN for those rules.
There was a problem hiding this comment.
i improved the comment
| /** | ||
| * Formatting options, separated by date and time. | ||
| */ | ||
| @Prop() formatOptions?: DatetimeFormatOptions; |
There was a problem hiding this comment.
It would be great to also improve the JSDoc comment here. This is the information that will show in the docs and intellisense.
Would be good to include what format it requires and maybe a link out to MDN for those rules.
|
Can we point this towards a feature branch instead of main? Might need to create a Also, it might be worth merging this into a branch and have that branch get merged into |
| printIonWarning(`Datetime: The '${presentation}' presentation requires a date object in formatOptions.`); | ||
| } | ||
| break; | ||
| case 'time': |
There was a problem hiding this comment.
mainly for my understanding: This is still needed for the upcoming ion-datetime-button integration right? For presentation="time" there's nothing in the datetime UI that would need formatOptions:
However, this would be needed for the time display in datetime button. Am I understanding correctly?
There was a problem hiding this comment.
That's correct!
Issue number: Internal --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> The Datetime header, Datetime time button, and Datetime Button have default date formatting that cannot be set by the developer. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - The developer can customize the date and time formatting for the Datetime header and time button - The developer can customize the date and time formatting for the Datetime Button - A warning will appear in the console if they try to provide a time zone (the time zone will not get used) - A warning will be logged if they do not include the date or time object for formatOptions as needed for the presentation of the Datetime ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change: 1. Describe the impact and migration path for existing applications below. 2. Update the BREAKING.md file with the breaking change. 3. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#footer for more information. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> These changes have been reviewed in #29009 and #29059. This PR just adds them to the feature branch now that the separate tickets are complete. --------- Co-authored-by: ionitron <[email protected]> Co-authored-by: Liam DeBeasi <[email protected]>
Issue number: Internal
What is the current behavior?
The Datetime header and time button have default date formatting that cannot be set by the developer.
What is the new behavior?
Does this introduce a breaking change?