vuecompo v1.0.5
@vuecompo/vuecompo.
This package providing a new design system for vuecompo that contains a foundation and many components based on the new design system. although this package developing for vuecompo, it will use for other vuecompo products in the future. In order to increase development speed and consistency on the style guide, we decided to use TailwindCSS. So this package uses TailwindCSS, Typescript and Vuejs.
NOTE: This package is under construction and it's not ready to use!
NOTE: These web components build for Vue.js 2.x / Nuxt.js 2.x
Features
- Responsive components
- Support Dark and Light mode
Installation
First install and configure TailwindCSS
with a minimal config then add @vuecompo/vuecompo
dependency to your project:
# using npm
npm install @vuecompo/vuecompo
# using yarn
yarn add @vuecompo/vuecompo
Add it to your project:
Nuxtjs
- Create a plugin with
vuecompo.js
name
// vuecompo.js
import Vue from 'vue';
import zwc from '@vuecompo/vuecompo';
import '@vuecompo/vuecompo/dist/zwc.css';
Vue.use(zwc);
- Add plugin to
nuxt.config.js
// nuxt.config.js
...
plugins: [
'~/plugin/vuecompo',
],
...
- Add purge to
tailwind.config.js
// tailwind.config.js
...
purge: [
'node_modules/@vuecompo/vuecompo/**/*.vue',
],
...
Usage
After installation, you just need to add components anywhere you want
<!-- *.vue -->
<button size="large">My Button</button>
Contributing
We're haven't any contributing guidelines yet because this package built as an intra-organizational project.