Skip to content
/ buefy Public
forked from buefy/buefy

Lightweight UI components for Vue.js based on Bulma

License

Notifications You must be signed in to change notification settings

tmepple/buefy

 
 

Repository files navigation

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 and Demo

The documentation is in the docs directory, it serves as the demo as well.

Browse the online documentation here.

Quick Start

You need Vue.js version 2.4+.

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="//fonts.googleapis.com/icon?family=Material+Icons">

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)

Versioning

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

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

As soon as it's stable and v1 is ready, I'll switch to vX.Y.Z (SemVer).

Browser Support

  • Firefox 38+
  • Chrome 38+
  • Edge 13+
  • Opera 44+
  • Safari 7+
  • Internet Explorer 10+ is only partially supported

Might work in other versions, but it's not tested.

Credits and Thanks

Copyright and License

Copyright (c) 2017 Rafael Beraldo. Code released under the MIT license.


Twitter @rafaelpimpa

About

Lightweight UI components for Vue.js based on Bulma

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 59.1%
  • JavaScript 21.3%
  • CSS 18.0%
  • HTML 1.6%