https://github.com/praella-agency/polaris-vue
Polaris Vue by HulkApps is a component library for Vue.js based on Shopify Polaris style guide.
https://github.com/praella-agency/polaris-vue
shopify shopify-polaris vue vuejs
Last synced: about 1 month ago
JSON representation
Polaris Vue by HulkApps is a component library for Vue.js based on Shopify Polaris style guide.
- Host: GitHub
- URL: https://github.com/praella-agency/polaris-vue
- Owner: praella-agency
- License: mit
- Created: 2020-07-22T14:18:35.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T11:16:00.000Z (about 1 year ago)
- Last Synced: 2025-04-09T22:17:47.226Z (about 1 month ago)
- Topics: shopify, shopify-polaris, vue, vuejs
- Language: Vue
- Homepage: https://polaris-vue.hulkapps.com
- Size: 8.6 MB
- Stars: 37
- Watchers: 2
- Forks: 10
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# This package and repository are no longer supported.
Please find other alternative packages for Polaris vue3 - https://www.npmjs.com/package/@mumble/vue3-polaris and https://ownego.github.io/polaris-vue/?path=/story/get-started--page
# Polaris Vue
Polaris Vue by HulkApps is a component library for [Vue.js](https://vuejs.org/) based on [Shopify Polaris style guide](https://polaris.shopify.com/).
## Documentation
You could browse [online documentation here](https://polaris-vue.hulkapps.com/).
## Quick start
You need [Vue.js](https://vuejs.org/) **version 2+**.
### 1. Install via npm
#### Using NPM
```bash
npm i @hulkapps/polaris-vue
```
#### Using Yarn
```bash
yarn add @hulkapps/polaris-vue
```
### 2. Import and use Polaris Vue
```javascript
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
```javascript
'/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](https://github.com/HulkApps/polaris-vue/blob/master/LICENSE) license.