Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 2.09 KB

README.md

File metadata and controls

56 lines (43 loc) · 2.09 KB

VueFace

NPM version Build Status npm Dependency Status Crates.io

VueFace is an open source component library for VueJS framework with around 40 components at the moment. It supports 20+ themes for giving different look & feel for all the components.

Follow me @SudheerJonna for technical updates.

Install

VueFace is available in NPM and you can add to your project as a dependency as below

npm install --save vueface

Quick start

The VueFace library need to be configured before going to use the components

import Vue from 'vue'
import VueFace from 'vueface'

Vue.use(VueFace)

Configure styles for your components in your home.vue/index.html. Forexample, add below resources to home.vue as below

<style id="current-theme" lang="css" src="node_modules/src/assets/themes/omega/theme.css"></style>
<style lang="css" src="node_modules/src/assets/vue-face.css"></style>
<style lang="css" src="node_modules/font-awesome/css/font-awesome.min.css"></style>

Demo

The showcase is available here(https://sudheerj.github.io/vueface) for each component and their features.

How to Run

build for production with minification

npm run build

serve with hot reload at localhost:8080

npm start

LICENSE

MIT