Install the package by running:

# If you use npm:
npm install @shopify/polaris-viz --save

# If you prefer Yarn, use the following command instead:
yarn add @shopify/polaris-viz
Copy

Wrap the top-level component of your app with the PolarisVizProvider.

import {PolarisVizProvider} from '@shopify/polaris-viz';

export const YourTopLevelComponent = () => {
  return (
    <PolarisVizProvider>
      <App />
    </PolarisVizProvider>
  );
};
Copy

If your app is set up to consume esnext builds, import components where you want to use them and the styles will automatically be applied.

If your app is not set up for esnext, import the styles where you import components from the library:

import '@shopify/polaris-viz/build/esm/styles.css';
Copy

Polaris Viz has react@^16.8.6 as a peer dependency.

You are responsible for providing this package in your project. By requiring this package as peerDependencies we can be sure there won't be duplicate packages included due to version mismatches.