Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 1.87 KB

README.md

File metadata and controls

79 lines (63 loc) · 1.87 KB

vue-strap

Bootstrap components built with Vue.js.

This repository contains a set of native Vue.js components based on Bootstrap's markup and CSS. As a result no dependency on jQuery or Bootstrap's JavaScript is required. The only required dependencies are:

  • Vue.js (required ^v2.x.x, test with v2.0.3).
  • Bootstrap CSS (required 3.x.x, test with 3.3.6). VueStrap doesn't depend on a very precise version of Bootstrap.

Installation

NPM

$ npm install github:wffranco/vue-strap --save

CommonJS

var alert = require('vue-strap/src/alert');
// or
var alert = require('vue-strap').alert;

new Vue({
  components: {
    'alert': alert
  }
})

ES6

import alert from 'vue-strap/src/alert'
// or
import { alert } from 'vue-strap'

new Vue({
  components: {
    alert
  }
})

AMD

$ bower install vue-strap

define(['vue-strap'], function(VueStrap) { var alert = VueStrap.alert; ... });

Browser globals

The dist folder contains vue-strap.js and vue-strap.min.js with all components exported in the window.VueStrap object. These bundles are also available in CDNJS, and on both the Bower and NPM packages.

<script src="path/to/vue.js"></script>
<script src="path/to/vue-strap.js"></script>
<script>
    var vm = new Vue({
        components: {
            alert: VueStrap.alert
        },
        el: "#app",
        data: {
            showRight: false,
            showTop: false
        }
    })
</script>

Docs

See the documentation with live editable examples.

Local Setup

  • Run the docs site in development mode with npm run docs. This will watch for file changes as you work.
  • Build with npm run build.

License

vue-strap is licensed under The MIT License.