@visx/responsive
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.1 • Public • Published

    @visx/responsive

    The @visx/responsive package is here to help you make responsive graphs.

    With Enhancers

    withScreenSize

    withParentSize

    With Components

    ParentSize

    ScaleSVG

    withScreenSize

    If you would like your graph to adapt to the screen size, you can use withScreenSize(). The resulting component will pass screenWidth and screenHeight props to the wrapped component containing the respective screen dimensions.

    Example:

    import { withScreenSize } from '@visx/responsive';
    // or
    // import * as Responsive from '@visx/responsive';
    // Responsive.withScreenSize(...);
    
    let chartToRender = withScreenSize(MySuperCoolVisxChart);
    
    // ... Render the chartToRender somewhere

    withParentSize

    If you would like your graph to adapt to it's parent component's size, you can use withParentSize(). The resulting component will pass parentWidth and parentHeight props to the wrapped component containing the respective parent's dimensions.

    Example:

    import { withParentSize } from '@visx/responsive';
    // or
    // import * as Responsive from '@visx/responsive';
    // Responsive.withParentSize(...);
    
    let chartToRender = withParentSize(MySuperCoolVisxChart);
    
    // ... Render the chartToRender somewhere

    ParentSize

    You might do the same thing using the ParentSize component.

    Example:

    import { ParentSize } from '@visx/responsive';
    // or
    // import * as Responsive from '@visx/responsive';
    // <Responsive.ParentSize />;
    
    let chartToRender = (
      <ParentSize>
        {parent => (
          <MySuperCoolVisxChart
            parentWidth={parent.width}
            parentHeight={parent.height}
            parentTop={parent.top}
            parentLeft={parent.left}
            // this is the referer to the wrapper component
            parentRef={parent.ref}
            // this function can be called inside MySuperCoolVisxChart to cause a resize of the wrapper component
            resizeParent={parent.resize}
          />
        )}
      </ParentSize>
    );
    
    // ... Render the chartToRender somewhere

    ScaleSVG

    You can also create a responsive chart with a specific viewBox with the ScaleSVG component.

    Example:

    import { ScaleSVG } from '@visx/responsive';
    // or
    // import * as Responsive from '@visx/responsive';
    // <Responsive.ScaleSVG />
    
    let chartToRender = (
      <ScaleSVG width={400} height={400}>
        <MySuperCoolVXChart />
      </ScaleSVG>
    );
    
    // ... Render the chartToRender somewhere
    ⚠️ ResizeObserver dependency

    If you don't need a polyfill for ResizeObserver or are already including it in your bundle, you should use ParentSizeModern and withParentSizeModern which doesn't include the polyfill.

    Installation

    npm install --save @visx/responsive
    

    Install

    npm i @visx/responsive

    DownloadsWeekly Downloads

    82,023

    Version

    2.4.1

    License

    MIT

    Unpacked Size

    83.5 kB

    Total Files

    35

    Last publish

    Collaborators

    • vx-hshoff
    • hshoff
    • christopher.card.williams
    • lencioni