From 325653dab826e662fc6906ba47f654fa5e0bd643 Mon Sep 17 00:00:00 2001 From: Lukas Date: Wed, 16 Oct 2024 15:35:00 +0300 Subject: [PATCH] Avoid proptypes for internal components --- .../src/BarChartPro/BarChartPro.tsx | 3 +++ .../src/LineChartPro/LineChartPro.tsx | 9 +++++++++ packages/x-data-grid/src/components/GridRow.tsx | 3 +++ .../src/components/base/GridOverlays.tsx | 3 +++ .../src/DateRangeCalendar/DateRangeCalendar.tsx | 3 +++ .../PickersSectionList/PickersSectionList.tsx | 17 ++++++++++------- 6 files changed, 31 insertions(+), 7 deletions(-) diff --git a/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx b/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx index 0c3af2884f477..1c53685b291aa 100644 --- a/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx +++ b/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx @@ -18,6 +18,9 @@ import { ZoomSetup } from '../context/ZoomProvider/ZoomSetup'; import { useZoom } from '../context/ZoomProvider/useZoom'; import { ZoomProps } from '../context/ZoomProvider'; +/** + * @ignore - internal component. + */ function BarChartPlotZoom(props: BarPlotProps) { const { isInteracting } = useZoom(); diff --git a/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx b/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx index 732756fe17315..72191f48470b7 100644 --- a/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx +++ b/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx @@ -26,16 +26,25 @@ import { ZoomSetup } from '../context/ZoomProvider/ZoomSetup'; import { useZoom } from '../context/ZoomProvider/useZoom'; import { ZoomProps } from '../context/ZoomProvider'; +/** + * @ignore - internal component. + */ function AreaPlotZoom(props: AreaPlotProps) { const { isInteracting } = useZoom(); return ; } +/** + * @ignore - internal component. + */ function LinePlotZoom(props: LinePlotProps) { const { isInteracting } = useZoom(); return ; } +/** + * @ignore - internal component. + */ function MarkPlotZoom(props: MarkPlotProps) { const { isInteracting } = useZoom(); return ; diff --git a/packages/x-data-grid/src/components/GridRow.tsx b/packages/x-data-grid/src/components/GridRow.tsx index 03c8b20797fc8..03c8dd7f138e8 100644 --- a/packages/x-data-grid/src/components/GridRow.tsx +++ b/packages/x-data-grid/src/components/GridRow.tsx @@ -67,6 +67,9 @@ export interface GridRowProps extends React.HTMLAttributes { [x: string]: any; // Allow custom attributes like data-* and aria-* } +/** + * @ignore - internal component. + */ function EmptyCell({ width }: { width: number }) { if (!width) { return null; diff --git a/packages/x-data-grid/src/components/base/GridOverlays.tsx b/packages/x-data-grid/src/components/base/GridOverlays.tsx index e21561bcdf273..2e098d090a99b 100644 --- a/packages/x-data-grid/src/components/base/GridOverlays.tsx +++ b/packages/x-data-grid/src/components/base/GridOverlays.tsx @@ -61,6 +61,9 @@ const useUtilityClasses = (ownerState: OwnerState) => { return composeClasses(slots, getDataGridUtilityClass, classes); }; +/** + * @ignore - internal component. + */ function GridOverlayWrapper(props: React.PropsWithChildren) { const apiRef = useGridApiContext(); const rootProps = useGridRootProps(); diff --git a/packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.tsx b/packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.tsx index 823a5adc4fa01..9a71f70a9b1da 100644 --- a/packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.tsx +++ b/packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.tsx @@ -79,6 +79,9 @@ const DateRangeCalendarMonthContainer = styled('div', { const weeksContainerHeight = (DAY_RANGE_SIZE + DAY_MARGIN * 2) * 6; +/** + * @ignore - internal component. + */ const DayCalendarForRange = styled(DayCalendar)(({ theme }) => ({ minWidth: 312, minHeight: weeksContainerHeight, diff --git a/packages/x-date-pickers/src/PickersSectionList/PickersSectionList.tsx b/packages/x-date-pickers/src/PickersSectionList/PickersSectionList.tsx index 362fecaaa716b..d4d4549327096 100644 --- a/packages/x-date-pickers/src/PickersSectionList/PickersSectionList.tsx +++ b/packages/x-date-pickers/src/PickersSectionList/PickersSectionList.tsx @@ -61,13 +61,7 @@ interface PickersSectionProps extends Pick, ) => React.JSX.Element) & { propTypes?: any }; +/** + * Demos: + * + * - [Custom field](https://mui.com/x/react-date-pickers/custom-field/) + * + * API: + * + * - [PickersSectionList API](https://mui.com/x/api/date-pickers/pickers-section-list/) + */ const PickersSectionList = React.forwardRef(function PickersSectionList( inProps: PickersSectionListProps, ref: React.Ref,