@lekseek/ui/README.md

Vue 3 components library

# LekSeek UI

![logo](/uploads/3c61d0bcee43850dbf856008764b0eba/logo.png)


#### Vue 3 components library written in TypeScript and Sass with design system by LekSeek

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Documentation](#documentation)
- [Features](#features)
- [Installation](#installation)
- [Quick start](#quick-start)
- [License](#license)

## Documentation
To check out docs, visit ##TODO## page.

## Features
- 50+ UI components,
- directives,
- customizable styles (sass variables),
- internationalization,
- support for font awesome icons,
- typescript support,
- helper css classes,
- ... and more

## Installation

`npm i @lekseek/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 Ui from '@lekseek/ui';

createApp(App)
  .use(createUI({}))
  .mount('#app');
```

Import stylesheet file:

```scss
@import '~@lekseek/ui/dist/lekseek-ui';
```

Install Lekseek icons in your project:

```bash
npm i @lekseek/lekseek-icons
```

and import icons in your styles:

```scss
@import '~@lekseek/icons/dist/lekseek-icons.css';
```