review changes

airbnb · Feb 18, 2024 · 8101893 · 8101893
1 parent 7ac5d96
commit 8101893
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 4 deletions.
diff --git a/packages/visx-responsive/Readme.md b/packages/visx-responsive/Readme.md
@@ -46,7 +46,7 @@ const MySuperCoolVisxChart = ({ myProp, screenWidth, screenHeight }: Props) => {
 
 const ChartToRender = withScreenSize(MySuperCoolVisxChart);
 
-const chartToRender = <ChartToRender />;
+const chartToRender = <ChartToRender myProp="string" />;
 
 // ... Render the chartToRender somewhere
 ```
@@ -80,7 +80,7 @@ const MySuperCoolVisxChart = ({ myProp, parentWidth, parentHeight }: Props) => {
 
 const ChartWithParentSize = withParentSize(MySuperCoolVisxChart);
 
-const chartToRender = <ChartWithParentSize initialWidth={400} />;
+const chartToRender = <ChartWithParentSize myProp="string" initialWidth={400} />;
 
 // ... Render the chartToRender somewhere
 ```

diff --git a/packages/visx-responsive/src/enhancers/withParentSize.tsx b/packages/visx-responsive/src/enhancers/withParentSize.tsx
@@ -9,6 +9,15 @@ interface PrivateWindow {
   ResizeObserver: ResizeObserverPolyfill;
 }
 
+/**
+ * @deprecated
+ * @TODO remove in the next major version - exported for backwards compatibility
+ */
+export type WithParentSizeProps = Pick<
+  WithParentSizeConfig,
+  'debounceTime' | 'enableDebounceLeadingCall'
+>;
+
 type WithParentSizeConfig = {
   debounceTime?: number;
   enableDebounceLeadingCall?: boolean;

diff --git a/packages/visx-responsive/src/enhancers/withScreenSize.tsx b/packages/visx-responsive/src/enhancers/withScreenSize.tsx
@@ -7,6 +7,12 @@ type WithScreenSizeConfig = {
   enableDebounceLeadingCall?: boolean;
 };
 
+/**
+ * @deprecated
+ * @TODO remove in the next major version - exported for backwards compatibility
+ */
+export type WithParentSizeProps = WithScreenSizeConfig;
+
 type WithScreenSizeState = {
   screenWidth?: number;
   screenHeight?: number;

diff --git a/packages/visx-responsive/test/withParentSize.test.tsx b/packages/visx-responsive/test/withParentSize.test.tsx
@@ -21,8 +21,14 @@ describe('withParentSize', () => {
   });
 
   test('it should pass parentWidth and parentHeight props to its child', () => {
-    const HOC = withParentSize(Component, ResizeObserver);
-    const { getByTestId } = render(<HOC role="img" initialWidth={200} initialHeight={200} />);
+    const WrappedComponent = withParentSize(Component, ResizeObserver);
+
+    // @ts-expect-error ensure unknown types still error
+    render(<WrappedComponent unknown="prop" />);
+
+    const { getByTestId } = render(
+      <WrappedComponent role="img" initialWidth={200} initialHeight={200} />,
+    );
 
     const RenderedComponent = getByTestId('Component');
     expect(RenderedComponent).toHaveStyle('width: 200px; height: 200px');