equal-vue/README.md

Equal is a Vue 3 hackable UI library empowered by tailwindcss

<p align="center">
  <a href="https://equal-ui.github.io/Equal/">
    <img width="150" src="./docs/public/logo.svg">
  </a>

<p align="center">
<img src="https://img.shields.io/npm/v/equal-vue?color=blue">
<img src="https://img.shields.io/npm/l/equal-vue">
<img src="https://img.shields.io/npm/dw/equal-vue">
<img src="https://img.badgesize.io/https:/unpkg.com/equal-vue/?label=Brotli%20size%3A%20JS&compression=brotli">
</p>
</p>

<h1 align="center">
  Equal UI
</h2>

<div align="center">
Equal UI is a Vue 3 hackable components library with 30+ components on top of Tailwindcss
<br>
  <a href="https://equal-ui.github.io/Equal/"><strong>Explore Equal UI docs</strong></a>
</div>

# Features

- 🔥 One of the best visuals in Vue ecosystem
- 🌃 Built-in dark theme
- 🎨 Full customization
- 💬 Have tooltips, notifications, popovers
- 👌 Lightweight: 12KB brotli
- 🔧 Includes 30+ components
- 💅 Uses your Tailwindcss classes

# Links

<b> Twitter: </b> [@Yan](https://twitter.com/k0mmsussertod)

# Install

You need [Vue.js](https://v3.vuejs.org/) version 3.1+

```bash
# npm
npm install equal-vue
```

```bash
# yarn
yarn add equal-vue
```

# Usage

## All components

```js
import { createApp } from 'vue'
import Equal from 'equal-vue'
import Config from 'equal-vue/dist/theme/full' // or light / dark theme

createApp.use(Equal, Config)
```

## Or individual components

```js
import { createApp } from 'vue'
import { Button, Switch } from 'equal-vue'
import Config from 'equal-vue/dist/theme/full' // or light / dark theme

createApp.use(Button, Config).use(Switch, Config)
```

# License

[MIT](https://raw.githubusercontent.com/Equal-UI/Equal/master/LICENSE)