Shopify’s product component library
Clone or download
tmlayton Merge pull request #860 from Shopify/button-keyboard-events
[Button] keypress, keydown, and keyup events
Latest commit dbd6173 Jan 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Replace playground with Storybook Jan 8, 2019
.github update deprecation info in contributing guidelines Jan 11, 2019
.storybook Merge pull request #861 from Shopify/storybook-pokes Jan 15, 2019
.vscode Shopify App Bridge 🌉🎉 (#2450) Oct 19, 2018
config Improve ordering of the CSS build Jan 15, 2019
documentation add deprecation category and changelog entry Jan 11, 2019
examples Upgrade webpack example per CVE-2018-14732 and dependencies Jan 4, 2019
playground Replace playground with Storybook Jan 8, 2019
scripts Compile using Babel 7 Jan 9, 2019
src pass event Jan 16, 2019
tests Add shopify/jest eslint ruleset and apply autofixes Nov 1, 2018
.editorconfig Allow trailing whitespace in diff and markdown files (#1499) Jun 7, 2018
.eslintignore Replace playground with Storybook Jan 8, 2019
.eslintrc Fix cyclical type imports relating to color-picker helpers Dec 17, 2018
.gitignore Replace playground with Storybook Jan 8, 2019
.nvmrc Update to use node v10.13.0 Nov 5, 2018
.prettierignore Replace playground with Storybook Jan 8, 2019
.prettierrc Stop prettier rampaging over markdown files May 28, 2018
.stylelintignore Replace playground with Storybook Jan 8, 2019
.yarnclean Upgrade to React 16 Oct 19, 2017
CHANGELOG.md update changelog for 3.5.0 release Jan 16, 2019
LICENSE.md Update license (#2489) Oct 24, 2018
README.md v3.5.0 Jan 16, 2019
UNRELEASED.md add changelog entry Jan 16, 2019
a11y_shitlist.json Remove components with no errors from the shitlist Sep 12, 2018
app.json [yarn tophat] Fix app loading issues on Heroku (#2027) Aug 27, 2018
dev.yml Replace playground with Storybook Jan 8, 2019
package.json v3.5.0 Jan 16, 2019
pre-commit Make pre-commit hook pass if playground is not staged Sep 20, 2018
secrets.ejson Update github credentials May 11, 2017
service.yml Add oncall to service.yml Dec 10, 2018
sewing-kit.config.ts Bump sewing-kit version Nov 13, 2018
shipit.yml Add percy to production ci ignore Aug 24, 2018
tsconfig.json Bump babel compile target to es2017 Jan 10, 2019
yarn.lock Version bumps storybook and fix README hotreloading Jan 12, 2019

README.md

Polaris React

npm version CircleCI build status codecov PRs Welcome join the Shopify Partners Slack #polaris channel

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.

App development

For more information about creating apps for the Shopify App Store, take a look at the app development documentation.

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/3.5.0/polaris.min.css"
/>

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

import '@shopify/polaris/styles.css';
  1. Include any of the provided components in your project:
import {AppProvider, Page, Card, Button} from '@shopify/polaris';
  1. 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'),
);

Building an embedded app

We provide React wrappers around the Shopify App Bridge (formerly known as the EASDK). You don’t need to go through the initialization of the Shopify App Bridge as described in the docs. Instead, configure the connection to the Shopify admin through the app provider 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/3.5.0/polaris.min.css"
/>
  1. 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:

Development

We use Storybook to create 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 remains pristine for other developers to work on.

Testing on mobile or a virtual machine

  1. Run yarn dev
  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.

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 sub-pixel 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 manual. While everyone can view changes, only members of the Shopify team an approve changes.

Manual visual regression testing

To start a server for manually viewing the visual regression testing examples, run yarn run dev.

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:

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 under a custom license based on MIT. The license restricts Polaris usage to applications that integrate or interoperate with Shopify software or services, with additional restrictions for external, stand-alone applications.
  • All icons and images are licensed under the Polaris Design Guidelines License Agreement