Polaris React

Polaris React is a component library designed to help developers create the best experience for merchants who use Shopify. Visit the Polaris style guide to learn more.

Using the React components

While we do offer a CSS-only version, we strongly recommend using the React versions of our components. It’s the version that we’ll be using at Shopify. It allows for rich, complex components like Tabs and Popovers, and will not have as many breaking changes as the CSS-only version.

Installation

Run the following command using npm:

npm install @shopify/polaris --save

If you prefer Yarn, use the following command instead:

yarn add @shopify/polaris

Usage

1. Include the CSS in your HTML:

 <link rel="stylesheet" href="https://sdks.shopifycdn.com/polaris/2.6.0-beta.3/polaris.min.css" />

Note: you can import the CSS directly into your project if your asset packager supports it:

import '@shopify/polaris/styles.css';

2. Include any of the provided components in your project:

import {AppProvider, Page, Card, Button} from '@shopify/polaris';

3. Tell React to render the element in the DOM:

ReactDOM.render(
  <AppProvider>
    <Page title="Example app">
      <Card sectioned>
        <Button onClick={() => alert('Button clicked!')}>Example button</Button>
      </Card>
    </Page>
  </AppProvider>,
  document.querySelector('#app'),
);

Using the Embedded App SDK

We provide React wrappers around Shopify’s Embedded App SDK (EASDK). You don’t need to go through the initialization of the EASDK as described in the docs. Instead, configure the connection to the Admin through the AppProvider component.

Using the CSS components

If React doesn’t make sense for your application, you can use a CSS-only version of our components. This includes all the styles you need for every component in the library, but you’ll be responsible for writing the correct markup and updating classes and DOM attributes in response to user events.

Usage

1. Include the CSS in your HTML:

<link rel="stylesheet" href="https://sdks.shopifycdn.com/polaris/2.6.0-beta.3/polaris.min.css" />

2. Include the markup and associated classes in your HTML document:

<button class="Polaris-Button">Example button</button>

Examples

We have created example applications to document some of the ways you could include Polaris in one of your own applications. Each of these examples includes further documentation on how to install dependencies and run the app:

• create-react-app example
• Webpack example
• Browserify example
• CSS-only example

Development

We’ve created a simple, hot-reloading playground for development on these components. You can edit the playground/Playground.tsx file to import the components you are working on, and run yarn dev in order to start the development server. Please do not commit your work on the playground so that it is pristine for other developers to work on.

Testing on mobile or a virtual machine

1. Run yarn dev:host
2. Visit http://YOUR_IP_ADDRESS:ASSIGNED_PORT in a browser window from within your virtual machine or mobile device on the same network

Testing in a consuming project

• Run yarn run build-consumer PROJECT_DIRECTORY

PROJECT_DIRECTORY is where the build will be copied, which must be a sibling of the polaris-react directory.

# Example
yarn run build-consumer polaris-styleguide

In the example above, the build is copied to polaris-styleguide/node_modules/@shopify/polaris. And in this case, a rebuild of polaris-styleguide is required after copying the polaris-react build, but may not be the case for all consuming projects.

# Example
cd ../polaris-styleguide/
yarn run build:development

Also, when running yarn install, copied builds will be overwritten and will require running yarn run build-consumer PROJECT_DIRECTORY again.

Learning resources

If you’re new to React, we recommend you start with the official React Getting Started documentation. As you read through the topics we suggest you follow along using their React Hello World CodePen example.

Additional resources:

• Online training courses at reacttraining.com, buildwithreact.com, and reactforbeginners.com.
• The community resources in Awesome React.
• As questions and find answers in the various React support communities.

Methodology

We set out to make our components easy to use. Each of our components has a well-documented (and fully typed) public interface with strong, consistently-applied conventions. This way, developers don’t need to worry about the underlying implementation. Instead, they can focus on creating amazing merchant experiences.

We ensure that our components are made for everyone. They meet accessibility standards and are responsive to any screen or device. We also put a lot of effort into optimizing the performance of the components, so everyone can build inclusive experiences that work.

We make our components flexible enough to meet diverse needs. They present the information you pass in and give you smart callbacks when something has changed, but they don’t enforce any structure beyond that. No matter what type of experience you’re creating, you can use components as the building blocks of your product or feature.

Contributing

Pull requests are welcome. See the contribution guidelines for more information.

Licenses

• Source code is licensed under MIT
• All icons and images are licensed under Creative Commons Attribution-NoDerivatives 4.0

For Shopify developers only

Visual regression testing

Percy runs for every pull request. Percy is a tool that compares screenshots for every single component we have in the library.

Percy is not always 100% accurate. Since it uses screenshot comparison, even browser subpixel rendering differences can cause Percy to ask for user confirmation of whether a change was intended or not. In cases like that, use your best judgement to determine whether you need to address it or not. This is why the choice to approve something or not is always left to the contributor.

Percy is a tool that’s supposed to help you and give you more confidence, not some checker that you need to appease. The final call lies with you as a contributor.

Running visual regression tests locally

1. Build and start the component examples server:

   yarn run tophat

2. In a separate terminal session, run:

   PERCY_TOKEN=aaaabbbbcccc \
   PERCY_PROJECT=Shopify/polaris-react \
   PERCY_BRANCH=local \
   yarn run test:percy

   Where aaaabbbbcccc is the API key available in the Percy project settings page for polaris-react.
3. Check tests results: https://percy.io/Shopify/polaris-react (can’t view the results? Ask for access on Slack)