[DateTime] Add isUserChange support for DateInput
#2573
Conversation
packages/datetime/src/dateInput.tsx
Outdated
| @@ -73,9 +73,10 @@ export interface IDateInputProps extends IDatePickerBaseProps, IDateFormatProps, | |||
|
|
|||
| /** | |||
| * Called when the user selects a new valid date through the `DatePicker` or by typing | |||
| * in the input. | |||
| * in the input. The second argument is true if and only if the user clicked on a date in the | |||
| * calendar; it will be false if the date was changed by choosing a new month or year. | |||
There was a problem hiding this comment.
@qcz i just edited these docs a bit. question: is the arg true if the user types in a new date in the input?
There was a problem hiding this comment.
Good question! The current solution treats any real user input (selecting a date in the datepicker/datetimepicker, changing the input, clearing the date) as a manual change event, so only change events fired by year and month change is non-manual. As I usually set readonly in the inputProps to readonly, so users can only change the date by selecting a date in the datepicker, I did not really thought of the naming convention.
I think that isUserChange should be a better name choice (and it is already used by DateTimePickers). Maybe we should change the name of the argument to the same for DatePickers too so it will be consistent.
There was a problem hiding this comment.
+1 to isUserChange, please do that!
update prop docsPreview: documentation | landing | table |
qcz
changed the title
hasUserManuallySelectedDate support for DateInputisUserChange support for DateInput
hasUserManuallySelectedDate → isUserChangePreview: documentation | landing | table |
Fix lint errorPreview: documentation | landing | table |
|
@giladgray: Thanks! Looking forward to it! |
Fixes #2418
Checklist
Changes proposed in this pull request:
isUserChangesupport for DateInput to be able to distinguish month/year changes from real date selections.IDatePickerPropstoisUserChange, so all supported components use the same argument name.