@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

Examples

APIs

#<ParentSize />

# children(args: { ref: HTMLDivElement | null; resize: (state: ParentSizeState) => void; } & ParentSizeState) => ReactNoderequired

Child render function ({ width, height, top, left, ref, resize }) => ReactNode.

# classNamestring | undefined

Optional className to add to the parent div wrapper used for size measurement.

# debounceTimenumber | undefined

Child render updates upon resize are delayed until debounceTime milliseconds after the last resize event is observed.

Default 300

# enableDebounceLeadingCallboolean | undefined

Optional flag to toggle leading debounce calls. When set to true this will ensure that the component always renders immediately. (defaults to true)

Default true

# ignoreDimensions"width" | "height" | "left" | "top" | ("width" | "height" | "left" | "top")[] | undefined

Optional dimensions provided won't trigger a state change when changed.

Default []

# parentSizeStylesCSSProperties | undefined

Optional style object to apply to the parent div wrapper used for size measurement.

Default { width: '100%', height: '100%' }

#<ScaleSVG />

# childrenReactNode

Child SVG to scale, rendered as the child of the parent wrappers provided by this component <div><svg>{children}</svg></div>.

# heightstring | number | undefined

Height of the desired SVG.

# innerRef((instance: SVGSVGElement | null) => void) | RefObject<SVGSVGElement> | null | undefined

Ref to the parent <svg /> used for scaling.

# preserveAspectRatiostring | undefined

Whether to preserve SVG aspect ratio.

Default xMinYMin meet

# widthstring | number | undefined

Width of the desired SVG.

# xOriginstring | number | undefined

xOrigin of the desired SVG.

Default 0

# yOriginstring | number | undefined

yOrigin of the desired SVG.

Default 0