chro_ui/README.md

A SCSS - Vue Component Library

## CHRO_UI SCSS Component Library (Version 2.0.0)

## 🎉Information
This Package is a SCSS UI-Designlibrary. It is meant to be used in a VueJs Application. We've created a simple and minified Component Library for VueJs 2.
Fill free to customize and test it. Now, enjoy :D

RELEASE OF VERSION 2.0.0

## 🎨Installation
We strongly recommend NodeJs Version 14.17.5 LTS. Make sure that your Project is SCSS/SASS compatible and also contains TypeScript included.
We use [Bootstrap Icons](https://icons.getbootstrap.com/) as Icon Library


```bash
npm install chro_ui
```
In main.ts File, add:
```python
import {TestComponent} from 'chro_ui'
import './assets/index.scss'
```
In assets Folder, create the SCSS File and add:
```python
@import '~@chro_ui/dist/plugin.css';
```
## Examples (VueJs)

```python
<template>
<div>
    #Default Primary Button
    <chro-button title="Save data"/>

    #Secondary Button
    <chro-button type="secondary" title="Chancel Action"/>

    #Icon Button
    <chro-iButton type="secondary" title="Icon Button" iconClass="bi bi-app-indicator" />

    #Icon Button with Text
    <chro-button type="primary" title="Icon Button with Text" iconClass="bi bi-app-indicator">
        <template #iconBefore><i class="bi bi-app-indicator"></i></template>
    </chro-button>

    #Style a warning Alert
    <chro-alert type="warning" title="Please make sure that all fields are correct"/>
</div>    
</template>
```

## 📖Preview
Some Preview Images (there may be deviations)
![Buttons](https://github.com/DevChrisRoth/chro_ui/blob/3d6900ed9ceeb9775d24b9e92567a54fdb6e1258/Buttons.png?raw=true)
![Alerts](https://github.com/DevChrisRoth/chro_ui/blob/3d6900ed9ceeb9775d24b9e92567a54fdb6e1258/Alerts.png?raw=true)
![NotificationCard](https://github.com/DevChrisRoth/chro_ui/blob/3d6900ed9ceeb9775d24b9e92567a54fdb6e1258/NotificationCard.png?raw=true)
![Table](https://github.com/DevChrisRoth/chro_ui/blob/3d6900ed9ceeb9775d24b9e92567a54fdb6e1258/Table.png?raw=true)

## 📢Releasenotes

| Version     | Notes                                 |
| ----------- |:-------------------------------------:|
| 2.0.0       | 📢Fundamental change of the library 🔥🎉 | 
| 1.0.4       | Added GitHub Repository Link          | 
| 1.0.3       | Changed Readme File                   | 
| 1.0.2       | Add Preview Image                     | 
| 1.0.1       | Add Preview Image                     | 
| 1.0.0       | Released stable Version               | 
| 0.1.0       | SCSS Files combined into one file     |
| 0.0.9       | Added more colors to the color palette|
| 0.0.5       | First full release of UI-Kit          | 

## Contributing
If you have any suggestions for improvement or something with the project isn't working, don't hesitate to write to us by [E-mail](mailto:chrisrothbog@gmail.com). 


## License
[MIT](https://choosealicense.com/licenses/mit/)