Introduce a locale sensitive date-picker

[samuelmale]

Requirements

• This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.

For changes to apps

• My work conforms to the OpenMRS 3.0 Styleguide and design documentation.

If applicable

• My work includes tests or is validated by existing tests.
• I have updated the esm-framework mock to reflect any API changes I have made.

Summary

This PR basically introduces a locale-sensitive date-picker to the style-guide. So far it's a mix of Carbon and Adobe React Spectrum's (ARS) date-picker.

How does it work?

ARS' date-picker has more concrete support for Internationalization out of the box. The fact that it supports non-gregorian calendars was the most compelling factor for choosing this library. We simply render ARS's date-picker if the current locale is supported by ARS, otherwise, we default to Carbon's date-picker. Take note that all the "English" specific locales have been excluded from the ARS' supported locales.

What next?

• Carbonize the ARS's date-picker for more consistency
• Get rid of Carbon's date-picker

Screenshots

Related Issue

N/A

Other

Resources

• https://talk.openmrs.org/t/o3-embedding-international-calendars-datepicker-and-date-converter-to-o3/38226
• https://talk.openmrs.org/t/o3-supporting-non-western-calendars-ethiopia-and-beyond/36566

Shouts

Kudos to @sinteco for working on this

[samuelmale]

Early comments:

React Spectrum's picker has a white (rgb(248, 248, 248)) background color which makes it look a little weird if the container doesn't explicitly define boundaries. Maybe we should use the same color as Carbon's?

[ibacher]

Thanks for the nice work on this! A few things (this whole thing is a bit tricky), but hey.

[mseaton]

I added @mogoodrich as a reviewer, as I know he is interested in this functionality.

[mogoodrich]

I'm not familiar with this widget, so didn't do a full review, but please see my comments @samuelmale @ibacher @mseaton , especially the one about setting UTC date.

[ibacher]

Maybe we should use the same color as Carbon's?

I think this is the last thing for this particular PR. We essentially just style the react-spectrum component so it looks exactly like the Carbon component. Otherwise, it will clash with the rest of the UI.

Really nice work on this @samuelmale!

[ebambo]

@samuelmale thank you so much for working on this. @mseaton @ibacher @mogoodrich I agree and value everyone's comments and ideas shared for this PR but I have a special request: can we revert (temporarily) to the initial solution Samuel has proposed, of having the carbon date picker being returned if the timezone is English otherwise return the spectrum data picker. Am asking this because the Ethiopia Team needs this feature incorporated as soon as possible, they are rolling out O3 next week. They had initially forked everything but we managed to move them away from that. The plan is not to leave this as is but work on carbonizing the component as recommended.
CC @gracepotma

[mogoodrich]

@ebambo I haven't been following this super closely, but I'm generally okay with doing something temporary in order for you to move forward, as long as there is a plan to move away from the temporary solution. Defer to @samuelmale and @ibacher on the specifics.

[ibacher]

@ebambo In principle, I think it's fine to integrate something like the earlier version. The comments Mark and I made specifically around date calculations will need to be fixed. It would also be important to swap the call to getConfigStore() for a call to useConfig() because, as is, this is a memory leak. Finally, the last version of this PR that uses the Carbon component incorrectly assigns any value as a property of the DatePickerInput, instead of the DatePicker component.

As long as those minimal changes are addressed and we have some assurance that changing from DatePicker -> OpenmrsDatePicker will be tested with both the Ge'ez and Gregorian calendars, we can go ahead and merge the earlier version of this.

[ebambo]

@ibacher @mogoodrich thank you so much for prompt response. @ibacher sure thing, we will address the points you raised and merge the PR.

[samuelmale]

To minimize potential chaos, I have restricted this to locales specific to Ethiopia only.