add comments + update api

microsoft · Jan 27, 2025 · bf8d0ba · bf8d0ba
1 parent 340db7a
commit bf8d0ba
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 14 deletions.
diff --git a/packages/charts/react-charting/etc/react-charting.api.md b/packages/charts/react-charting/etc/react-charting.api.md
@@ -1212,18 +1212,21 @@ export interface IRefArrayData {
     refElement?: SVGGElement;
 }
 
-// @public (undocumented)
-export interface IResponsiveContainerProps {
+// @public
+export interface IResponsiveChildProps {
     // (undocumented)
-    children: React_2.ReactElement<{
-        width?: number;
-        height?: number;
-    }>;
+    height?: number;
     // (undocumented)
-    height?: number | string;
+    shouldResize?: number;
     // (undocumented)
+    width?: number;
+}
+
+// @public
+export interface IResponsiveContainerProps {
+    children: React_2.ReactElement<IResponsiveChildProps>;
+    height?: number | string;
     onResize?: (width: number, height: number) => void;
-    // (undocumented)
     width?: number | string;
 }
 
@@ -1652,7 +1655,7 @@ export enum NodesComposition {
 // @public
 export const PieChart: React_2.FunctionComponent<IPieChartProps>;
 
-// @public (undocumented)
+// @public
 export const ResponsiveContainer: React_2.FC<IResponsiveContainerProps>;
 
 // @public

diff --git a/packages/charts/react-charting/src/components/ResponsiveContainer/ResponsiveContainer.tsx b/packages/charts/react-charting/src/components/ResponsiveContainer/ResponsiveContainer.tsx
@@ -9,6 +9,10 @@ import { getStyles } from './ResponsiveContainer.styles';
 
 const getClassNames = classNamesFunction<{}, IResponsiveContainerStyles>();
 
+/**
+ * Responsive Container component
+ * {@docCategory ResponsiveContainer}
+ */
 export const ResponsiveContainer: React.FC<IResponsiveContainerProps> = props => {
   const containerRef = React.useRef<HTMLDivElement>(null);
   const onResizeRef = React.useRef<IResponsiveContainerProps['onResize']>();

diff --git a/...ges/charts/react-charting/src/components/ResponsiveContainer/ResponsiveContainer.types.ts b/...ges/charts/react-charting/src/components/ResponsiveContainer/ResponsiveContainer.types.ts
@@ -1,30 +1,38 @@
 import * as React from 'react';
 import { IStyle } from '@fluentui/react/lib/Styling';
 
+/**
+ * Responsive Child props
+ * {@docCategory ResponsiveContainer}
+ */
 export interface IResponsiveChildProps {
   width?: number;
   height?: number;
   shouldResize?: number;
 }
 
+/**
+ * Responsive Container props
+ * {@docCategory ResponsiveContainer}
+ */
 export interface IResponsiveContainerProps {
   /**
-   *
+   * Width of the container
    */
   width?: number | string;
 
   /**
-   *
+   * Height of the container
    */
   height?: number | string;
 
   /**
-   *
+   * Callback providing the updated chart width and height values when the container is resized
    */
   onResize?: (width: number, height: number) => void;
 
   /**
-   *
+   * Child component to be rendered within the container
    */
   children: React.ReactElement<IResponsiveChildProps>;
 }

diff --git a/packages/charts/react-charting/src/index.ts b/packages/charts/react-charting/src/index.ts
@@ -138,7 +138,7 @@ export type { IGaugeChartProps, IGaugeChartSegment, IGaugeChartStyleProps, IGaug
 export { GaugeChart, GaugeChartVariant, GaugeValueFormat } from './GaugeChart';
 export type { DeclarativeChartProps, Schema, IDeclarativeChart, IImageExportOptions } from './DeclarativeChart';
 export { DeclarativeChart } from './DeclarativeChart';
-export type { IResponsiveContainerProps } from './ResponsiveContainer';
+export type { IResponsiveContainerProps, IResponsiveChildProps } from './ResponsiveContainer';
 export { ResponsiveContainer } from './ResponsiveContainer';
 
 import './version';