Buefy is a lightweight library of responsive UI components for Vue.js based on Bulma framework and design.
This branch buefy-next
aims at being Buefy for Vue 3.
The branch departed from the latest commit #b6233b9c335d99cf688ee2a3b9c61fd26a92a182 on the dev
branch as of July 4, 2023.
The initial migration goal was to make the documentation page of every component work, and it was achieved. Some features not used in the documentation pages may not work. Please refer to MIGRATION-NOTE.md for more details about what challenges we faced.
Due to focusing on the documentation pages:
- Unit tests have not been updated at all.
- Extensions have not migrated.
- Server-side-rendering has neither been tested.
Because not all of Vue 2 features could be reproduced with Vue 3, there are some breaking changes. Please refer to CHANGELOG.md for more details. The biggest breaking change is obviously, this does not work with Vue 2.
To install this fork, please run the following command,
npm install buefy@npm:@ntohq/buefy-next
The above command will install @ntohq/buefy-next
under the buefy
alias.
This is recommended because @ntohq/buefy-next
will replace buefy
when it becomes stable.
- 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 88KB 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
The documentation is in the docs directory, it serves as the demo as well.
Browse online documentation here.
You need Vue.js version 3.0+. (Vue 2 is not supported)
npm install buefy@npm:@ntohq/buefy-next
Bundle
import { createApp } from 'vue';
import Buefy from 'buefy';
import 'buefy/dist/buefy.css';
const app = createApp();
app.use(Buefy);
or Individual Components
import { createApp } from 'vue'
import { Field, Input } from 'buefy'
import 'buefy/dist/buefy.css'
const app = createApp();
app.use(Field)
app.use(Input)
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@5.8.55/css/materialdesignicons.min.css">
If you want to customize the icons or the theme, refer to the customization section on the documentation.
<!-- Buefy CSS -->
<link rel="stylesheet" href="https://unpkg.com/@ntohq/buefy-next/dist/buefy.min.css">
<!-- Buefy JavaScript -->
<script src="https://unpkg.com/@ntohq/buefy-next/dist/buefy.min.js"></script>
Currently, including buefy-next
via <script>
is not working.
Please see the issue #221.
To incorporate the latest changes from the development branch of buefy-next, you can install developer releases from the GitHub npm registry. However, proceed with caution as these packages may be deleted or retracted without notice.
Steps:
-
Generate a Personal Access Token:
Create a personal access token on GitHub with read access to the GitHub Packages registry.
-
Configure npm:
In your terminal, execute the following commands:
npm login --auth-type=legacy --registry=https://npm.pkg.github.com USERNAME: <their GitHub username> PASSWORD: <personal access token issued at Step 1> echo "@ntohq:registry=https://npm.pkg.github.com" > .npmrc
-
Select a Developer Release:
Visit the Buefy-next package registry: https://github.com/ntohq/buefy-next/pkgs/npm/buefy-next on GitHub.
Choose any developer release that suits your needs.
- Consider the features and bug fixes introduced in each release.
- Choose a more recent release if you need the latest features, but be aware of potential instabilities.
- Opt for a slightly older release if stability is a higher priority.
Package Naming Conventions:
Buefy-next developer releases follow a specific naming format:
@ntohq/buefy-next@<package version>-<dev commit hash>
<package version>
: This represents the intended stable release version that the developer release will eventually be included in.<dev commit hash>
: This part indicates that it's a developer release and includes a unique commit hash that identifies the specific code changes in that release. -
Install the Package:
Copy the provided command from GitHub, which will resemble this:
npm install buefy@npm:@ntohq/buefy-next@<package version>-<dev commit hash>
Alternatively, to fetch the latest release from the developer snapshot registry, run:
npm install buefy@npm:@ntohq/buefy-next@latest
However, note it is not recommended to use the latest version of our developer snapshot, as its stability fluctuates.
Congratulations! You've successfully installed a Buefy-next developer package.
For further details on the GitHub npm registry refer to the official GitHub documentation
https://github.com/buefy/buefy
Recent versions of Firefox, Chrome, Edge, Opera and Safari. IE10+ is only partially supported.
Please see the contributing guidelines
Version will follow v0.Y.Z, where:
- Y: Major (breaking changes)
- Z: Minor or patch
Kikuo Emoto |
Wesley Ford |
Special thanks to Rafael Beraldo, the original author, and Walter Tommasi, a former core maintainter of Buefy.
Thanks goes to these wonderful people (emoji key):
Rafael Beraldo 💻 |
Alexandre Paradis 💻 |
Yuxing Liao 💻 |
Adrien 💻 |
Apolokak Lab 💻 |
Antério Vieira 💻 |
Jorge Nieto 💻 |
Mateus Machado Luna 💻 |
All contributors |
This project follows the all-contributors specification. Contributions of any kind welcome!
Code released under MIT license.