https://github.com/vuebits/ui

Vuebits UI - Open source Vue 3 components library written in TypeScript and Sass
https://github.com/vuebits/ui

design-system sass scss ui ui-components ui-design ui-framework ui-kit uikit vue vue-components vue-js vue3 vue3-typescript vuejs

Last synced: about 19 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/vuebits/ui
• Owner: vuebits
• License: mit-0
• Created: 2021-02-25T16:34:33.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T10:55:38.000Z (5 months ago)
• Last Synced: 2024-12-19T17:02:28.608Z (6 days ago)
• Topics: design-system, sass, scss, ui, ui-components, ui-design, ui-framework, ui-kit, uikit, vue, vue-components, vue-js, vue3, vue3-typescript, vuejs
• Language: Vue
• Homepage: https://vuebits-ui.github.io/
• Size: 1.38 MB
• Stars: 7
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Vuebits UI




  

    

  



Vue 3 components library


## Table of Contents

- [Documentation](#documentation)

- [Features](#features)

- [Installation](#installation)

- [Quick start](#quick-start)

## Documentation

To check out docs, visit [vuebits-ui.github.io](https://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):

```javascript

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:

```scss

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

```

Install fontawesome icons in your project:

```bash

npm i @fortawesome/fontawesome-free

```

and import icons in your styles:

```scss

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

```

## License

[MIT](https://opensource.org/licenses/MIT)