Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pickers] Remove the defaultCalendarMonth prop #10987

Merged
merged 17 commits into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/data/migration/migration-pickers-v6/migration-pickers-v6.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,22 @@ You can read more about the deprecation of this prop in [v6 migration guide](/x/
/>
```

### Replace `defaultCalendarMonth` with `referenceDate`

The deprecated `defaultCalendarMonth` prop has been removed in favor of the more flexible `referenceDate` prop.

:::info
The new `referenceDate` prop is not limited to the default month.
It will also impact year, day, and time.

Learn more on this prop on [the `DateCalendar` documentation](/x/react-date-pickers/date-calendar/#choose-the-initial-year-month) or [the `referenceDate` documentation](/x/react-date-pickers/base-concepts/#reference-date-when-no-value-is-defined) pages.
:::

```diff
- <DateCalendar defaultCalendarMonth={dayjs('2022-04-01')};
+ <DateCalendar referenceDate{dayjs('2022-04-01')} />
```

## Modified props

### Remove the string argument of the `dayOfWeekFormatter` prop
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/date-calendar.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"desktopModeMediaQuery": {
"type": { "name": "string" },
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/date-range-calendar.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultRangePosition": {
"type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
"default": "'start'"
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/date-range-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultRangePosition": {
"type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
"default": "'start'"
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"desktopModeMediaQuery": {
"type": { "name": "string" },
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/desktop-date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultRangePosition": {
"type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
"default": "'start'"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/mobile-date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultRangePosition": {
"type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
"default": "'start'"
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/mobile-date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/static-date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultRangePosition": {
"type": { "name": "enum", "description": "'end'<br>&#124;&nbsp;'start'" },
"default": "'start'"
Expand Down
1 change: 0 additions & 1 deletion docs/pages/x/api/date-pickers/static-date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
"returned": "string"
}
},
"defaultCalendarMonth": { "type": { "name": "any" } },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
Expand Down
5 changes: 0 additions & 5 deletions docs/translations/api-docs/date-pickers/date-calendar.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default selected value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
5 changes: 0 additions & 5 deletions docs/translations/api-docs/date-pickers/date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value={[null, null]}</code>.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultRangePosition": {
"description": "The initial position in the edited date range. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value={[null, null]}</code>.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultRangePosition": {
"description": "The initial position in the edited date range. Used when the component is not controlled.",
"deprecated": "",
Expand Down
5 changes: 0 additions & 5 deletions docs/translations/api-docs/date-pickers/date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value={[null, null]}</code>.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultRangePosition": {
"description": "The initial position in the edited date range. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value={[null, null]}</code>.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultRangePosition": {
"description": "The initial position in the edited date range. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value={[null, null]}</code>.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultRangePosition": {
"description": "The initial position in the edited date range. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@
"string": "The name to display."
}
},
"defaultCalendarMonth": {
"description": "Default calendar month displayed when <code>value</code> and <code>defaultValue</code> are empty.",
"deprecated": "",
"typeDescriptions": {}
},
"defaultValue": {
"description": "The default value. Used when the component is not controlled.",
"deprecated": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,7 @@ describe('<DateRangeCalendar />', () => {
const onChange = spy();

render(
<DateRangeCalendar
onChange={onChange}
defaultCalendarMonth={adapterToUse.date('2019-01-01')}
/>,
<DateRangeCalendar onChange={onChange} referenceDate={adapterToUse.date('2019-01-01')} />,
);

fireEvent.click(getPickerDay('30', 'January 2019'));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,6 @@ const DateRangeCalendar = React.forwardRef(function DateRangeCalendar<TDate>(
shouldDisableDate,
reduceAnimations,
onMonthChange,
defaultCalendarMonth,
rangePosition: rangePositionProp,
defaultRangePosition: inDefaultRangePosition,
onRangePositionChange: inOnRangePositionChange,
Expand Down Expand Up @@ -324,7 +323,6 @@ const DateRangeCalendar = React.forwardRef(function DateRangeCalendar<TDate>(
} = useCalendarState<TDate>({
value: value[0] || value[1],
referenceDate,
defaultCalendarMonth,
disableFuture,
disablePast,
disableSwitchToMonthOnDayFocus: true,
Expand Down Expand Up @@ -642,10 +640,6 @@ DateRangeCalendar.propTypes = {
* @default (_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
*/
dayOfWeekFormatter: PropTypes.func,
/**
* Default calendar month displayed when `value={[null, null]}`.
*/
defaultCalendarMonth: PropTypes.any,
/**
* The initial position in the edited date range.
* Used when the component is not controlled.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,6 @@ export interface ExportedDateRangeCalendarProps<TDate>
* @default false
*/
disableAutoMonthSwitching?: boolean;
/**
* Default calendar month displayed when `value={[null, null]}`.
*/
defaultCalendarMonth?: TDate;
/**
* If `true`, the picker and text field are disabled.
* @default false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,6 @@ DateRangePicker.propTypes = {
* @default (_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
*/
dayOfWeekFormatter: PropTypes.func,
/**
* Default calendar month displayed when `value={[null, null]}`.
*/
defaultCalendarMonth: PropTypes.any,
/**
* The initial position in the edited date range.
* Used when the component is not controlled.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,6 @@ DesktopDateRangePicker.propTypes = {
* @default (_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
*/
dayOfWeekFormatter: PropTypes.func,
/**
* Default calendar month displayed when `value={[null, null]}`.
*/
defaultCalendarMonth: PropTypes.any,
/**
* The initial position in the edited date range.
* Used when the component is not controlled.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,6 @@ MobileDateRangePicker.propTypes = {
* @default (_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
*/
dayOfWeekFormatter: PropTypes.func,
/**
* Default calendar month displayed when `value={[null, null]}`.
*/
defaultCalendarMonth: PropTypes.any,
/**
* The initial position in the edited date range.
* Used when the component is not controlled.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,6 @@ StaticDateRangePicker.propTypes = {
* @default (_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
*/
dayOfWeekFormatter: PropTypes.func,
/**
* Default calendar month displayed when `value={[null, null]}`.
*/
defaultCalendarMonth: PropTypes.any,
/**
* The initial position in the edited date range.
* Used when the component is not controlled.
Expand Down
Loading