Fix: Datepicker: Unable to enter date manually

chuyler commented 2 years ago

Fixes #2956

Additional description

Previously, the DatePicker would try to format the value in the input box after every keystroke, preventing the user from actually typing out a date or changing an existing date by pressing the delete key in front of a character and replacing it with a new character. Additionally, passing in a new date value to the component did not update the value displayed in the input box.

This fix includes changes for:

Initialization of input state variables has been moved to getDerivedStateFromProps to allow updates from parent component
handleInputChange no longer calls parent onChange callback but instead waits until user presses ENTER or TAB
Pressing ESCAPE from within the input box resets the component to initial state

CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

[x] First-time contributors should sign the Contributor License Agreement. It's a fancy way of saying that you are giving away your contribution to this project. If you haven't before, wait a few minutes and a bot will comment on this pull request with instructions.
[x] npm run lint:fix has been run and linting passes.
[x] Mocha, Jest (Storyshots), and components/component-docs.json CI tests pass (npm test).
[x] Tests have been added for new props to prevent regressions in the future. See readme.
[x] Review the appropriate Storybook stories. Open http://localhost:9001/.
[x] Review tests are passing in the browser. Open http://localhost:8001/.
[x] Review markup conforms to SLDS by looking at DOM snapshot strings.

REVIEWER checklist (do not remove)

[ ] CircleCI tests pass. This includes linting, Mocha, Jest, Storyshots, and components/component-docs.json tests.
[ ] Tests have been added for new props to prevent regressions in the future. See readme.
[ ] Review the appropriate Storybook stories. Open http://localhost:9001/.
[ ] The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
[ ] Review tests are passing in the browser. Open http://localhost:8001/.
[ ] Review markup conforms to SLDS by looking at DOM snapshot strings.
Required only if there are markup / UX changes
[ ] Add year-first date and commit SHA to last-slds-markup-review in package.json and push.
[ ] Request a review of the deployed Heroku app by the Salesforce UX Accessibility Team.
[ ] Add year-first review date, and commit SHA, last-accessibility-review, to package.json and push.
[ ] While the contributor's branch is checked out, run npm run local-update within locally cloned site repo to confirm the site will function correctly at the next release.

welcome[bot] commented 2 years ago

Thanks for opening this pull request! :100:

This is a community-driven project, and we can't do it without your participation. Please check out our contributing guidelines and review the Contributor Checklist if you haven't already, to make sure everything is squared away. CircleCI will take about 10 minutes to run through the same items that are on the Contributor checklist with a pass/fail check below. Please fix any issues that cause CircleCI to fail or ask for clarification--we try, but sometimes the errors can be unclear. A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread. To ensure codebase quality, large code line changes may take more than 2 weeks to review, but may take longer depending on the number of pull requests in the queue. Feel free to ask for a status update at any time--you won't be bothering anyone. Once feedback has been given, please reply to the feedback giver once the feedback on been addressed, so that they can continue the review. If you need a release while you are waiting for a code review, you can publish a built tag to your own fork. See directions in the release README.

salesforce-cla[bot] commented 2 years ago

Thanks for the contribution! Before we can merge this, we need @chuyler to sign the Salesforce.com Contributor License Agreement.

interactivellama commented 2 years ago

Hi, I'm back from the dead!

This patterns appears to stop the Datepicker from being controlled by the state of the parent component and moves state into the Datepicker.

I could be missing something in the above statement, but components should be controlled components instead of uncontrolled per the project overview. https://github.com/salesforce/design-system-react/blob/master/docs/codebase-overview.md#use-controlled-components

chuyler commented 2 years ago

I'm not sure I follow your comment. Please go to current demo page for Date Picker.
https://react.lightningdesignsystem.com/components/date-pickers/

Let's say you don't want to use the widget to navigate to a date but instead you know the exact date and format you would like to type in. Click on the input box and start typing. You will find that the second you enter a number the picker widget closes and the box auto-completes to a date you didn't intend to enter.

If you have a better solution that would allow users to enter the date using the keyboard manually I would gladly review it.

chuyler commented 1 year ago

@interactivellama Could you provide an update on this? I'd really like to get this merged. If you have a better solution I'm all ears.

anujsingla commented 1 year ago

@interactivellama Could you please review this MR? We are also facing the same issue in our project

salesforce / design-system-react