praella-agency / polaris-vue

Polaris Vue by HulkApps is a component library for Vue.js based on Shopify Polaris style guide.

Polaris Vue

Polaris Vue by HulkApps is a component library for Vue.js based on Shopify Polaris style guide.

Documentation

You could browse online documentation here.

Quick start

You need Vue.js version 2+.

1. Install via npm

Using NPM

npm i @hulkapps/polaris-vue

Using Yarn

yarn add @hulkapps/polaris-vue

2. Import and use Polaris Vue

import Vue from 'vue';
import PolarisVue from '@hulkapps/polaris-vue';
import '@hulkapps/polaris-vue/dist/polaris-vue.min.css';
Vue.use(PolarisVue);

Other available builds

'/dist/polaris-vue.min.js';
'/dist/polaris-vue.ssr.js';
'/dist/polaris-vue.esm.js';

Contributing

If you notice any bugs, please create issue tickets. Also, pull requests are welcome.

License

Code released under MIT license.