xui/README.md

xUI Components for Angular

<p style="font-size: 5rem; font-weight: 700; text-align: center">
  <span style="color: #1f75cb">x</span>UI
</p>

---

[![Build status](https://circleci.com/gh/Rikarin/xui.svg?style=svg)](https://circleci.com/gh/Rikarin/xui)
[![Demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://xuijs.org/)
[![npm](https://img.shields.io/npm/v/xui.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/xui)
[![Downloads](https://img.shields.io/npm/dt/xui.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/xui)
[![Monthly Downloads](https://img.shields.io/npm/dm/xui.svg)](https://www.npmjs.com/package/xui)
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/xui.svg)](https://bundlephobia.com/result?p=xui)
[![License](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](/LICENSE)
[![Discord](https://img.shields.io/discord/776258487307075594.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/aPkZsFcu)
[![Netlify Status](https://api.netlify.com/api/v1/badges/fa0cfd14-97df-47fa-8a7c-152e6d4cfda2/deploy-status)](https://app.netlify.com/sites/xui/deploys)

xUI is a customizable Angular 15 UI Library with gaming look which can be easily adapted to your brand.
Contains default dark and light theme and also SCSS functions to generate your own theme in few steps.
Which can be also switch on runtime.

## What you'll get

- **Light and Dark** default themes easily customizable
- **33+ Angular UI Components** ready to be used
- **Great Theming Engine** - creating new components just in few steps
- **Configurable Options** - tweaking the components in various ways
- **Material Design Icons** - ready to be used https://mdisearch.com/

## Table of Contents

- [Documentation](https://xuijs.org)
- [Live Demo](https://cord.dj/r)
- [Installation](#installation)

<a name="installation"></a>

## Installation

Install package with **YARN**

```bash
yarn add xui
```

or **NPM**

```bash
npm install xui
```

## Browser Support

xUI Supports most recent browsers according to Angular [support](https://angular.io/guide/browser-support).

## Development

The project uses `NX` and `Angular` to build the package.

```bash
yarn start
```

## Issues

If you find any issues in the library or have and idea for an improvement feel free to open an [issue](https://github.com/Rikarin/xui/issues).