Lightweight UI components for Vue.js based on Bulma
Clone or download
Pull request Compare This branch is 5 commits ahead, 352 commits behind buefy:dev.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
build
config
docs
src
static
test
.babelrc
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.postcssrc.js
CHANGELOG.md
LICENSE
README.md
index.html
jsconfig.json
package-lock.json
package.json

README.md

Buefy

npm npm npm

Buefy is a lightweight library of responsive UI components for Vue.js based on Bulma framework and design.

Buefy

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-animations

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

import Vue from 'vue';
import Buefy from 'buefy';
import 'buefy/lib/buefy.css';

Vue.use(Buefy);

// OR

Vue.component(Buefy.Checkbox.name, Buefy.Checkbox);
Vue.component(Buefy.Table.name, Buefy.Table);
Vue.component(Buefy.Switch.name, Buefy.Switch);

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/lib/buefy.min.css">

<!-- Buefy JavaScript -->
<script src="https://unpkg.com/buefy"></script>
// Global variable
Vue.use(Buefy.default)

Browser support

Recent versions of Firefox, Chrome, Edge, Opera and Safari. IE10+ is only partially supported.

Versioning

While it's still in beta, version will follow v0.Y.Z, where:

  • Y: Major (breaking changes)
  • Z: Minor or patch

Stay in touch

Collaborators

License

Code released under MIT license.

Copyright (c) 2017, Rafael Beraldo.