@combine-labs/combine-polaris NPM

🆕 🎉 📰 All active development and issue tracking for Polaris React will be moving to this repository. At that time, we will start accepting pull requests. We look forward to your contributions!

Polaris

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

Running the Playground

Polaris comes with a sandbox project located under the /playground directory.

Installation

Go to the parent directory where you want the repository. $git clone this repo.
$ cd into the cloned repo.
$ git fetch
Work from an existing branch $ git checkout {branch_name}. Start a new branch $ git checkout -b {branch_name}.
$ npm install to install dependencies

Usage

$ npm start will host a site at http://localhost:8080
Add components to ./playground/Playground.tsx
Saving files will reload the server with the new changes

Using the React components

We strongly recommend using the React versions of our components. It’s the version that we’ll be using internally. 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

Include the CSS in your HTML:

 <link rel="stylesheet" href="https://sdks.shopifycdn.com/polaris/2.12.1/polaris.min.css" />

Note: you can import the CSS directly into your project if your asset packager supports it:
import '@shopify/polaris/styles.css';

Include any of the provided components in your project:

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

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

Include the CSS in your HTML:

<link rel="stylesheet" href="https://sdks.shopifycdn.com/polaris/2.12.1/polaris.min.css" />

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:

We’ve also created a simple, hot-reloading playground for these components. You can edit the playground/Playground.tsx file to import the components you want to play with, and run yarn dev in order to start the development server.

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

We’re working on making this project fully open source. We aren’t accepting pull requests, but issue reports and feature requests are welcome. See the contribution guidelines for more information.