> BereaUI is a lightweight library of responsive UI components for [Vue.js](https://vuejs.org/) based on [Tailwindcss](https://tailwindcss.com/) framework and design.
>
> *Check out the official [`@Berea-Soft/bereaui`](https://github.com/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](https://materialdesignicons.com/) and [FontAwesome](http://fontawesome.io/)
* Very lightweight with none internal dependencies aside from Vue & tailwindcss
* Semantic code output
* Follows tailwincss design and some of the [Material Design UX](https://material.io/)
* 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](https://bereaui.com/).
## Quick start
You need [Vue.js](https://vuejs.org/) **version 2.6+**. (Vue 3 is supported [here](https://github.com/Berea-Soft/bereaui))
### 1 Install via npm
```bash
npm install bereaui
```
### 2 Import and use Buefy
Bundle
```javascript
import Vue from 'vue';
import BereaUI from 'bereaui';
import 'bereaui/dist/bereaui.css';
Vue.use(BereaUI);
```
or Individual Components
```javascript
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
```html
```
If you want to customize the icons or the theme, refer to the [customization section on the documentation](https://bereaui.com/documentation/customization).
### Alternatively, you can use a CDN or even download
```html
```
## Start On Cloud IDE
[https://github.com/Berea-Soft/bereaui](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](./.github/CONTRIBUTING.md)
## Versioning
Version will follow **vMY.MN.PT**, where:
* **MY**: Major (breaking changes)
* **MN**: Minor
* **PT**: or patch
## Contributors ✨
## License
Code released under [MIT](https://github.com/Berea-Soft/bereaui/blob/master/LICENSE) license.
---
_Source: https://npm.io/package/bereaui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
Code released under [MIT](https://github.com/Berea-Soft/bereaui/blob/master/LICENSE) license.
---
_Source: https://npm.io/package/bereaui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._