buefy/buefy
Lightweight UI components for Vue.js based on Bulma
| repo name | buefy/buefy |
| repo link | https://github.com/buefy/buefy |
| homepage | https://buefy.org |
| language | Vue |
| size (curr.) | 23730 kB |
| stars (curr.) | 7165 |
| created | 2017-03-31 |
| license | MIT License |
Buefy is a lightweight library of responsive UI components for Vue.js based on Bulma framework and design.
Features
- Keep your current Bulma theme / variables easily
- Supports both Material Design Icons and FontAwesome
- Very lightweight with none internal dependencies aside from Vue & Bulma
- About 60KB min+gzip (with Bulma included)
- Semantic code output
- Follows Bulma design and some of the Material Design UX
- Focus on usability and performance without over-animating stuff
Documentation
The documentation is in the docs directory, it serves as the demo as well.
Browse online documentation here.
Quick start
You need Vue.js version 2.5+.
1 Install via npm
npm install buefy
2 Import and use Buefy
Bundle
import Vue from 'vue';
import Buefy from 'buefy';
import 'buefy/dist/buefy.css';
Vue.use(Buefy);
or Individual Components
import Vue from 'vue'
import { Field, Input } from 'buefy'
import 'buefy/dist/buefy.css'
Vue.use(Field)
Vue.use(Input)
3 Include Material Design Icons
<link rel="stylesheet" href="//cdn.materialdesignicons.com/2.0.46/css/materialdesignicons.min.css">
If you want to customize the icons or the theme, refer to the customization section on the documentation.
Alternatively, you can use a CDN or even download
<!-- Buefy CSS -->
<link rel="stylesheet" href="https://unpkg.com/buefy/dist/buefy.min.css">
<!-- Buefy JavaScript -->
<script src="https://unpkg.com/buefy/dist/buefy.min.js"></script>
Browser support
Recent versions of Firefox, Chrome, Edge, Opera and Safari. IE10+ is only partially supported.
Contributing
Please see the contributing guidelines
Versioning
While it’s still in beta, version will follow v0.Y.Z, where:
- Y: Major (breaking changes)
- Z: Minor or patch
Maintainers
Supporting through Patreon
Buefy is an open source MIT project if you are interested in supporting this project, please consider becoming a patron.
License
Code released under MIT license.
Copyright (c), Rafael Beraldo.
