mul14 / vuikit Goto Github PK

UIkit with all the power of Vue

Vuikit is a collection of Vue components built on top of the awesome UIkit framework. While it is possible to use UIkit by its own when building Vue components, you may find yourself building a wrapper around it to fill the missing logic gap or to make it behave more naturally with Vue. Vuikit solves all that by providing a precise, documented API.

Documentation and examples

There is a live demo at http://vuikit.github.io/vuikit with technical information about each component. As well as a codepen playground.

Dependencies

• Vue (^1.0.24)
• UIkit (^2.26.0)
• jQuery (Inherited UIkit dependency)

Code Samples

Note that all code examples are using ES6 syntax

Vuikit components are registered globally by default and ready to be used immediately.

import Vue from 'vue'
import Vuikit from 'vuikit'

Vue.use(Vuikit)

<template>
  <div>
    <vk-button-checkbox>
      <vk-button color="primary">Button</vk-button>
      <vk-button active>Button</vk-button>
      <vk-button>Button</vk-button>
    </vk-button-checkbox>
  </div>
</template>

Although is possible to load and register them individually.

import Vue from 'vue'
import { Button, Alert } from 'vuikit'

// globally
Vue.component('VkButton', Button)
Vue.component('VkAlert', Alert)

// or locally
new Vue({
  components: {
    VkButton: Button,
    VkAlert: Alert
  }
})

Changing the output or adding specific features is straightforward by extending a component.

import Vue from 'vue'
import { Button } from 'vuikit'

Vue.component('TmButton', {
  extends: Button,
  template: '', // the new output
  props: {} // new features
  ...
})

Configuration and Usage

NPM

npm install vuikit --save

import Vue from 'vue'
import Vuikit from 'vuikit'

Vue.use(Vuikit) // or register individually

By default all dependencies will be retrieved from node_modules, but that will not work straightforward as UIkit expects jQuery to be loaded globally. To avoid this and other related issues is recommended to solve the dependencies loading externally. When building with Webpack or Browserify you can do so by setting the externals or external config property.

Browser

Make sure jQuery, UIkit and Vue are loaded upfront and then load dist/vuikit.js.

Developers

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for distribution
npm run build

License

Vuikit is open source and released under the MIT License.

Copyright (c) 2016 ZOOlanders.com