[DateRangePicker] Fix currentMonthCalendarPosition not scrolling to future sibling

[GMchris]

fixes #14418

[mui-bot]

Deploy preview: https://deploy-preview-14442--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against d4ade93

[LukasTy]

Thank you for noticing and handling this issue! 🙏

I took the liberty to add a test asserting this behavior.

@GMchris Your changes impact the commercially licensed code. For any changes of this nature, we require contributors to sign the MUI’s Contributor License Agreement (CLA).

However, this change looks like a pretty trivial bugfix that we could accept without the CLA process if we both agree that the fix is trivial: https://www.notion.so/mui-org/CLA-Contributor-License-Agreement-92ece655b1584b10b00e4de9e67eedb0?pvs=4#ede845886e494cb4b802a67563152130.
WDYT?
If you wish to go through the CLA process, please let me know and follow this guide. 😉

[GMchris]

Hey, @LukasTy , I've followed the CLA guide and submitted both form and email.

[oliviertassinari]

@LukasTy Two side thoughts:

1. When requesting for a CLA, to add the CLA: required label to prevent someone else from merging without noticing. Now, to be fair, the fix is really simple, there isn't much IP to get, so we could have almost merged without.
2. https://mui.com/x/react-date-pickers/date-range-calendar/#choose-the-months-to-render I have my doubts about this currentMonthCalendarPosition props, I would almost better see a prop that is a date that represents the current month displayed. I mean, we have

   mui-x/packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.types.ts

   Line 98 in dd98382

   currentMonthCalendarPosition?: 1 | 2 | 3;

   but shouldn't people be able to use -10, +10 too?

[LukasTy]

Thank you for the insights @oliviertassinari.

1. When requesting for a CLA, to add the CLA: required label to prevent someone else from merging without noticing. Now, to be fair, the fix is really simple, there isn't much IP to get, so we could have almost merged without.

Thanks, next time I will either not approve the PR or add the necessary label until the CLA topic is resolved.
This is the second time we have had a "trivial"-like change and previously agreed to merge without signing. 😉

2. https://mui.com/x/react-date-pickers/date-range-calendar/#choose-the-months-to-render I have my doubts about this currentMonthCalendarPosition props, I would almost better see a prop that is a date that represents the current month displayed. I mean, we have

mui-x/packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.types.ts

Line 98 in dd98382

currentMonthCalendarPosition?: 1 | 2 | 3;

but shouldn't people be able to use -10, +10 too?

It can be -10 or +10 if someone needs it, just like anyone is free to specify whatever amount of calendars they want (except for overriding the TS error or PropTypes warning). 😉
We have previously had a currentMonth prop, but that was replaced with referenceDate.
What use case do you see for -10 or +10? 🤔

[oliviertassinari]

@LukasTy Ah, ok, so referenceDate and currentMonthCalendarPosition are meant to be used at the same time. This makes sense 👍. I could see a warning when using a value below 1 and above 3 to explain the alternative.

The thing in my mind was about: how can a developer control the view displayed in the pickers? react-day-pickers allows people to https://daypicker.dev/docs/navigation#onmonthchange. A month prop sounds too specific though, I would expect a date prop that the component ensures is "visible" in the UI.

referenceDate is close but seems to be only the default value.

[LukasTy]

The thing in my mind was about: how can a developer control the view displayed in the pickers? react-day-pickers allows people to https://daypicker.dev/docs/navigation#onmonthchange. A month prop sounds too specific though, I would expect a date prop that the component ensures is "visible" in the UI.

referenceDate is close but seems to be only the default value.

Great point, thank you for bringing up this possible need. 👍
There is already an issue for it (#10869), I have added specific priority to it so that it does not get lost. 👍
We might have overlooked this need with the referenceDate implementation. 🤔