Avoid proptypes for internal components

mui · Oct 16, 2024 · 325653d · 325653d
1 parent 2c81a89
commit 325653d
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 7 deletions.
diff --git 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
@@ -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 <AreaPlot {...props} skipAnimation={isInteracting || undefined} />;
 }
 
+/**
+ * @ignore - internal component.
+ */
 function LinePlotZoom(props: LinePlotProps) {
   const { isInteracting } = useZoom();
   return <LinePlot {...props} skipAnimation={isInteracting || undefined} />;
 }
 
+/**
+ * @ignore - internal component.
+ */
 function MarkPlotZoom(props: MarkPlotProps) {
   const { isInteracting } = useZoom();
   return <MarkPlot {...props} skipAnimation={isInteracting || undefined} />;

diff --git 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<HTMLDivElement> {
   [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
@@ -61,6 +61,9 @@ const useUtilityClasses = (ownerState: OwnerState) => {
   return composeClasses(slots, getDataGridUtilityClass, classes);
 };
 
+/**
+ * @ignore - internal component.
+ */
 function GridOverlayWrapper(props: React.PropsWithChildren<GridOverlaysProps>) {
   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
@@ -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
@@ -61,13 +61,7 @@ interface PickersSectionProps extends Pick<PickersSectionListProps, 'slots' | 's
 }
 
 /**
- * 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/)
+ * @ignore - internal component.
  */
 function PickersSection(props: PickersSectionProps) {
   const { slots, slotProps, element, classes } = props;
@@ -120,6 +114,15 @@ type PickersSectionListComponent = ((
   props: PickersSectionListProps & React.RefAttributes<HTMLDivElement>,
 ) => 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<HTMLDivElement>,