Skip to content
/ ui Public

Vuebits UI - Open source Vue 3 components library written in TypeScript and Sass

License

Notifications You must be signed in to change notification settings

vuebits/ui

Repository files navigation

Vuebits UI

Vuebits UI

Vue 3 components library

Table of Contents

Documentation

To check out docs, visit vuebits-ui.github.io page.

Features

  • 45+ UI components,
  • directives,
  • customizable styles (sass variables),
  • internationalization,
  • compatibility with all popular icon systems,
  • full typescript support,
  • helper css classes,
  • ... and more

Installation

npm i @vuebits/ui / yarn add @vuebits/ui

Quick start

Add library to your Vue 3 app in entry file (eg. main.js):

import { createApp } from 'vue';
import App from './App.vue';
import { createUI } from '@vuebits/ui';

const config = {
  // your config here
};

createApp(App)
  .use(createUI(config))
  .mount('#app');

Import stylesheet file:

@import '~@vuebits/ui/styles';

Install fontawesome icons in your project:

npm i @fortawesome/fontawesome-free

and import icons in your styles:

@import '~@fortawesome/fontawesome-free/css/all.css';

License

MIT