{{pkg.name}} {{pkg.version}}

{{pkg.description}}

Installation

Compiled

Minified CSS and JavaScript with no documentation or original source files.

bower install {{pkg.name}} --save-dev

Source

Source Sass, JavaScript, and documentation files.

npm install {{pkg.name}} --save-dev

Usage

For compiled components, use it within your Vue instance like this:

new Vue({ components: { '{{componentNameSurfixed}}': {{pkg.library}}.{{componentName}} }})

OR

If you chosen to work with source components, just import* desired component like so:

import { {{componentNameCamelCase}} } from '{{pkg.name}}/src/components'

and then load it in your Vue instance:

new Vue({ components: { {{componentNameCamelCase}} }})

*Note: You will need Babel Loader in your Webpack config file to support ES6 syntax.

Examples

Theming

To be able to use your app theme with component's scss variables, you will need to use vuestrap-theme-loader in your webpack config file.

npm install vuestrap-theme-loader --save-dev

See vuestrap-starter for a webpack config example with theme loader.