bereaui
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

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

Check out the official @Berea-Soft/bereaui fork in development for Vue v3.0.0+ support.

Features

  • Keep your current Bulma theme / variables easily
  • Supports both Material Design Icons and FontAwesome
  • Very lightweight with none internal dependencies aside from Vue & tailwindcss
  • Semantic code output
  • Follows tailwincss 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.6+. (Vue 3 is supported here)

1 Install via npm

npm install bereaui

2 Import and use Buefy

Bundle

import Vue from 'vue';
import BereaUI from 'bereaui';
import 'bereaui/dist/bereaui.css';

Vue.use(BereaUI);

or Individual Components

import Vue from 'vue'
import { BeField, BeInput } from 'bereaui'
import 'bereaui/dist/bereaui.css'

Vue.use(BeField)
Vue.use(BeInput)

3 Include Material Design Icons

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

Alternatively, you can use a CDN or even download

<!-- BereaUI CSS -->
<link rel="stylesheet" href="https://unpkg.com/bereaui/dist/bereaui.min.css">

<!-- BereaUI JavaScript -->
<script src="https://unpkg.com/bereaui/dist/bereaui.min.js"></script>

Start On Cloud IDE

https://github.com/Berea-Soft/bereaui

Browser support

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

Contributing

Please see the contributing guidelines

Versioning

Version will follow vMY.MN.PT, where:

  • MY: Major (breaking changes)
  • MN: Minor
  • PT: or patch

Contributors ✨

License

Code released under MIT license.

Package Sidebar

Install

npm i bereaui

Homepage

bereaui.com

Weekly Downloads

1

Version

0.0.2

License

MIT

Unpacked Size

70.9 kB

Total Files

13

Last publish

Collaborators

  • bereaui