https://github.com/Shopify/polaris-viz

A collection of React and React native components that compose Shopify's data visualization system
https://github.com/Shopify/polaris-viz

Last synced: about 1 month ago
JSON representation

A collection of React and React native components that compose Shopify's data visualization system

• Host: GitHub
• URL: https://github.com/Shopify/polaris-viz
• Owner: Shopify
• License: other
• Created: 2019-12-18T14:15:44.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T18:57:13.000Z (5 months ago)
• Last Synced: 2024-05-01T23:12:33.967Z (5 months ago)
• Language: TypeScript
• Homepage: https://polaris-viz.shopify.com
• Size: 97.4 MB
• Stars: 291
• Watchers: 213
• Forks: 21
• Open Issues: 97
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        




**Polaris Viz** is Shopify's data visualization system. It's what powers many of our data heavy experiences, including [ShopifyQL Notebooks](https://shopify.engineering/shopify-commerce-data-querying-language-shopifyql).

It is composed of two consumer-facing libraries:




-  `polaris-viz`

![version badge](https://img.shields.io/npm/v/@shopify/polaris-viz)

![size badge](https://img.shields.io/bundlephobia/minzip/@shopify/polaris-viz)

 a collection of React components built for **web**




- `polaris-viz-native`

![version badge](https://img.shields.io/npm/v/@shopify/polaris-viz-native)

![size badge](https://img.shields.io/bundlephobia/minzip/@shopify/polaris-viz-native)

  a collection of React Native components optimized for **mobile experiences**




Both libraries use the same [Data Structure](https://polaris-viz.shopify.com/?path=/docs/shared-data-structure--page), [Utility functions](https://polaris-viz.shopify.com/?path=/docs/shared-utilities-accessibility-color-vision-events--page), [Themes](https://polaris-viz.shopify.com/?path=/docs/shared-themes-default-themes--page) and SubComponents. _All things shared_ between `@shopify/polaris-viz` and `@shopify/polaris-viz-native` are documented in the Storybook's `Shared` folder

- [📓 Docs & Examples](https://polaris-viz.shopify.com/)

- [🖥 Getting Started with Polaris Viz](https://polaris-viz.shopify.com/?path=/docs/polaris-viz-getting-started--page)

- [📱 Getting Started with Polaris Viz **Native**](https://polaris-viz.shopify.com/?path=/docs/polaris-viz-native-getting-started--page)









Our libraries are structured to favor charts that prioritize accessibility and motion design. The goal is to help users create clear and meaningful analytics experiences.

We want to do the heavy lifting of developing charts, so our partners can focus on telling amazing data stories and not re-inventing the wheel.











  
🤝 Contributing




Want to help us build the future of data viz?

The system is currently in active development and we are working on expanding its features and available charts.

Pull requests are welcome! See the [contribution docs](https://github.com/Shopify/polaris-viz/blob/master/CONTRIBUTING.md) for more information and to learn how to set up your development environment.











  
📃 Licenses



 Source code is under a [custom license](https://github.com/Shopify/polaris-viz/blob/main/LICENSE.md) based on MIT. The license restricts Polaris Viz usage to applications that integrate or interoperate with Shopify software or services, with additional restrictions for external, stand-alone applications.