@onekind/carbon-vue v1.0.0

@onekind/carbon-vue

An opinionated Vue implementation of IBM™ Carbon Design System version 10.

• Project setup
  • Using storybook for development
  • Compiles and minifies for production
  • Run your unit tests
  • Lints and fixes files
• Using Carbon Vue in your project
  • Using with Vue
  • Using with Nuxt
• Component List
• Acknowledgement

Project setup

npm install

Using storybook for development

npm run storybook

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint

Using Carbon Vue in your project

Add carbon-vue to your project, as a dependency:

npm install @onekind/carbon-vue

Using with Vue

Add the following to your App.vue file:

import Vue from 'vue'
import CarbonVue from '@onekind/carbon-vue'
Vue.use(CarbonVue)

Using with Nuxt

Add a carbon-vue.js to /plugins folder:

import Vue from 'vue'
import CarbonVue from '@onekind/carbon-vue'
Vue.use(CarbonVue)

Add your new plugin in nuxt.config.js

plugins: [
  'carbon-vue.js`
]

you can use any other name for the file.

Component List

Acknowledgement

A big thanks to IBM™ for making Carbon Design System publicly available. It gives us the opportunity of inspecting good professional work, even if many would disagree on the design language or approach.

This project uses lots of open source projects, and benefits from them. So a huge thanks to anyone contributing to those.