[lab] Add TypeScript deprecations (mui#38833)

mnajdova · Sep 8, 2023 · 4989fd7 · 4989fd7
1 parent 9b7bb1e
commit 4989fd7
Show file tree

Hide file tree

Showing 30 changed files with 43 additions and 4 deletions.
diff --git a/docs/pages/blog/lab-tree-view-to-mui-x.md b/docs/pages/blog/lab-tree-view-to-mui-x.md
@@ -56,8 +56,14 @@ Follow the [migration steps](/x/migration/migration-tree-view-lab/) by updating
 
 ```diff
 -import TreeView from '@mui/lab/TreeView';
+-import TreeItem from '@mui/lab/TreeItem';
 +import { TreeView } from '@mui/x-tree-view/TreeView';
++import { TreeItem } from '@mui/x-tree-view/TreeItem';
+```
+
+or
 
+```diff
 -import { TreeView, TreeItem } from '@mui/lab';
 +import { TreeView, TreeItem } from '@mui/x-tree-view';
 ```

diff --git a/packages/mui-lab/src/AdapterDateFns/AdapterDateFns.ts b/packages/mui-lab/src/AdapterDateFns/AdapterDateFns.ts
@@ -16,7 +16,9 @@ const warn = () => {
   }
 };
 
-// tslint:disable-next-line:no-unnecessary-class
+/**
+ * @deprecated The AdapterDateFns class was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
+ */
 export default class AdapterDateFns {
   constructor() {
     warn();

diff --git a/packages/mui-lab/src/AdapterDayjs/AdapterDayjs.ts b/packages/mui-lab/src/AdapterDayjs/AdapterDayjs.ts
@@ -16,7 +16,9 @@ const warn = () => {
   }
 };
 
-// tslint:disable-next-line:no-unnecessary-class
+/**
+ * @deprecated The AdapterDayjs class was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
+ */
 export default class AdapterDayjs {
   constructor() {
     warn();

diff --git a/packages/mui-lab/src/AdapterLuxon/AdapterLuxon.ts b/packages/mui-lab/src/AdapterLuxon/AdapterLuxon.ts
@@ -16,7 +16,9 @@ const warn = () => {
   }
 };
 
-// tslint:disable-next-line:no-unnecessary-class
+/**
+ * @deprecated The AdapterLuxon class was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
+ */
 export default class AdapterLuxon {
   constructor() {
     warn();

diff --git a/packages/mui-lab/src/AdapterMoment/AdapterMoment.ts b/packages/mui-lab/src/AdapterMoment/AdapterMoment.ts
@@ -16,7 +16,9 @@ const warn = () => {
   }
 };
 
-// tslint:disable-next-line:no-unnecessary-class
+/**
+ * @deprecated The AdapterMoment class was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
+ */
 export default class AdapterMoment {
   constructor() {
     warn();

diff --git a/packages/mui-lab/src/CalendarPicker/CalendarPicker.tsx b/packages/mui-lab/src/CalendarPicker/CalendarPicker.tsx
@@ -25,6 +25,7 @@ type CalendarPickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The CalendarPicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const CalendarPicker = React.forwardRef(function DeprecatedCalendarPicker() {

diff --git a/packages/mui-lab/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx b/packages/mui-lab/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx
@@ -25,6 +25,7 @@ type CalendarPickerSkeletonComponent = ((
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The CalendarPickerSkeleton component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const CalendarPickerSkeleton = React.forwardRef(function DeprecatedCalendarPickerSkeleton() {

diff --git a/packages/mui-lab/src/ClockPicker/ClockPicker.tsx b/packages/mui-lab/src/ClockPicker/ClockPicker.tsx
@@ -25,6 +25,7 @@ type ClockPickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The ClockPicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const ClockPicker = React.forwardRef(function DeprecatedClockPicker() {

diff --git a/packages/mui-lab/src/DateRangePicker/DateRangePicker.ts b/packages/mui-lab/src/DateRangePicker/DateRangePicker.ts
@@ -26,6 +26,7 @@ type DateRangePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DateRangePicker component was moved from `@mui/lab` to `@mui/x-date-pickers-pro`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DateRangePicker = React.forwardRef(function DeprecatedDateRangePicker() {

diff --git a/packages/mui-lab/src/DateRangePickerDay/DateRangePickerDay.ts b/packages/mui-lab/src/DateRangePickerDay/DateRangePickerDay.ts
@@ -25,6 +25,7 @@ type DateRangePickerDayComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DateRangePickerDay component was moved from `@mui/lab` to `@mui/x-date-pickers-pro`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DateRangePickerDay = React.forwardRef(function DeprecatedDateRangePickerDay() {

diff --git a/packages/mui-lab/src/DateTimePicker/DateTimePicker.tsx b/packages/mui-lab/src/DateTimePicker/DateTimePicker.tsx
@@ -25,6 +25,7 @@ type DateTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DateTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DateTimePicker = React.forwardRef(function DeprecatedDateTimePicker() {

diff --git a/packages/mui-lab/src/DesktopDatePicker/DesktopDatePicker.tsx b/packages/mui-lab/src/DesktopDatePicker/DesktopDatePicker.tsx
@@ -25,6 +25,7 @@ type DesktopDatePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DesktopDatePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DesktopDatePicker = React.forwardRef(function DeprecatedDesktopDatePicker<TDate>() {

diff --git a/packages/mui-lab/src/DesktopDateRangePicker/DesktopDateRangePicker.ts b/packages/mui-lab/src/DesktopDateRangePicker/DesktopDateRangePicker.ts
@@ -26,6 +26,7 @@ type DesktopDateRangePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DesktopDateRangePicker component was moved from `@mui/lab` to `@mui/x-date-pickers-pro`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DesktopDateRangePicker = React.forwardRef(function DeprecatedDesktopDateRangePicker() {

diff --git a/packages/mui-lab/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx b/packages/mui-lab/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx
@@ -25,6 +25,7 @@ type DesktopDateTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DesktopDateTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DesktopDateTimePicker = React.forwardRef(function DeprecatedDesktopDateTimePicker() {

diff --git a/packages/mui-lab/src/DesktopTimePicker/DesktopTimePicker.tsx b/packages/mui-lab/src/DesktopTimePicker/DesktopTimePicker.tsx
@@ -25,6 +25,7 @@ type DesktopTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The DesktopTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers-pro`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const DesktopTimePicker = React.forwardRef(function DeprecatedDesktopTimePicker() {

diff --git a/packages/mui-lab/src/LocalizationProvider/LocalizationProvider.tsx b/packages/mui-lab/src/LocalizationProvider/LocalizationProvider.tsx
@@ -24,6 +24,7 @@ type LocalizationProviderComponent = ((
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The LocalizationProvider component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const LocalizationProvider = React.forwardRef(function DeprecatedLocalizationProvider() {

diff --git a/packages/mui-lab/src/MobileDatePicker/MobileDatePicker.tsx b/packages/mui-lab/src/MobileDatePicker/MobileDatePicker.tsx
@@ -25,6 +25,7 @@ type MobileDatePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The MobileDatePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const MobileDatePicker = React.forwardRef(function DeprecatedMobileDatePicker<TDate>(

diff --git a/packages/mui-lab/src/MobileDateRangePicker/MobileDateRangePicker.ts b/packages/mui-lab/src/MobileDateRangePicker/MobileDateRangePicker.ts
@@ -26,6 +26,7 @@ type MobileDateRangePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The MobileDateRangePicker component was moved from `@mui/lab` to `@mui/x-date-pickers-pro`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const MobileDateRangePicker = React.forwardRef(function DeprecatedMobileDateRangePicker() {

diff --git a/packages/mui-lab/src/MobileDateTimePicker/MobileDateTimePicker.tsx b/packages/mui-lab/src/MobileDateTimePicker/MobileDateTimePicker.tsx
@@ -25,6 +25,7 @@ type MobileDateTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The MobileDateTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const MobileDateTimePicker = React.forwardRef(function DeprecatedMobileDateTimePicker() {

diff --git a/packages/mui-lab/src/MobileTimePicker/MobileTimePicker.tsx b/packages/mui-lab/src/MobileTimePicker/MobileTimePicker.tsx
@@ -25,6 +25,7 @@ type MobileTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The MobileTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const MobileTimePicker = React.forwardRef(function DeprecatedMobileTimePicker() {

diff --git a/packages/mui-lab/src/MonthPicker/MonthPicker.tsx b/packages/mui-lab/src/MonthPicker/MonthPicker.tsx
@@ -25,6 +25,7 @@ type MonthPickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The MonthPicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const MonthPicker = React.forwardRef(function DeprecatedMonthPicker() {

diff --git a/packages/mui-lab/src/PickersDay/PickersDay.tsx b/packages/mui-lab/src/PickersDay/PickersDay.tsx
@@ -25,6 +25,7 @@ type PickersDayComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The PickersDay component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const PickersDay = React.forwardRef(function DeprecatedPickersDay<TDate>() {

diff --git a/packages/mui-lab/src/StaticDatePicker/StaticDatePicker.tsx b/packages/mui-lab/src/StaticDatePicker/StaticDatePicker.tsx
@@ -25,6 +25,7 @@ type StaticDatePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The StaticDatePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const StaticDatePicker = React.forwardRef(function DeprecatedStaticDatePicker() {

diff --git a/packages/mui-lab/src/StaticDateRangePicker/StaticDateRangePicker.ts b/packages/mui-lab/src/StaticDateRangePicker/StaticDateRangePicker.ts
@@ -26,6 +26,7 @@ type StaticDateRangePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The StaticDateRangePicker component was moved from `@mui/lab` to `@mui/x-date-pickers-pro`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const StaticDateRangePicker = React.forwardRef(function DeprecatedStaticDateRangePicker() {

diff --git a/packages/mui-lab/src/StaticDateTimePicker/StaticDateTimePicker.tsx b/packages/mui-lab/src/StaticDateTimePicker/StaticDateTimePicker.tsx
@@ -25,6 +25,7 @@ type StaticDateTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The StaticDateTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const StaticDateTimePicker = React.forwardRef(function DeprecatedStaticDateTimePicker() {

diff --git a/packages/mui-lab/src/StaticTimePicker/StaticTimePicker.tsx b/packages/mui-lab/src/StaticTimePicker/StaticTimePicker.tsx
@@ -25,6 +25,7 @@ type StaticTimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The StaticTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const StaticTimePicker = React.forwardRef(function DeprecatedStaticTimePicker() {

diff --git a/packages/mui-lab/src/TimePicker/TimePicker.tsx b/packages/mui-lab/src/TimePicker/TimePicker.tsx
@@ -25,6 +25,7 @@ type TimePickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The StaticTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const TimePicker = React.forwardRef(function DeprecatedTimePicker() {

diff --git a/packages/mui-lab/src/TreeItem/TreeItem.tsx b/packages/mui-lab/src/TreeItem/TreeItem.tsx
@@ -23,6 +23,7 @@ const warn = () => {
 };
 
 /**
+ * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
  * @ignore - do not document.
  */
 const TreeItem = React.forwardRef(function DeprecatedTreeItem(

diff --git a/packages/mui-lab/src/TreeView/TreeView.tsx b/packages/mui-lab/src/TreeView/TreeView.tsx
@@ -23,6 +23,7 @@ const warn = () => {
 };
 
 /**
+ * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
  * @ignore - do not document.
  */
 const TreeView = React.forwardRef(function DeprecatedTreeView(

diff --git a/packages/mui-lab/src/YearPicker/YearPicker.tsx b/packages/mui-lab/src/YearPicker/YearPicker.tsx
@@ -25,6 +25,7 @@ type YearPickerComponent = (<TDate>(
 ) => JSX.Element) & { propTypes?: any };
 
 /**
+ * @deprecated The YearPicker component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.
  * @ignore - do not document.
  */
 const YearPicker = function DeprecatedYearPicker() {
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,6 +23,7 @@ const warn = () => { @@
     };
     /**
+     * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this migration on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
      * @ignore - do not document.
      */
     const TreeItem = React.forwardRef(function DeprecatedTreeItem(
@@ Expand Down @@