@xui/components/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://github.com/rikarin/xui/actions/workflows/continuous-delivery.yaml/badge.svg?branch=master)
[![Demo](https://img.shields.io/badge/demo-online-ed1c46)](https://xuijs.org/)
[![npm](https://img.shields.io/npm/v/%40xui/components.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/org/xui)
[![Downloads](https://img.shields.io/npm/dt/%40xui/components.svg)](https://www.npmjs.com/org/xui)
[![Monthly Downloads](https://img.shields.io/npm/dm/%40xui/components.svg)](https://www.npmjs.com/org/xui)
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/%40xui/components)](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 - 16 UI Library with gaming look which can be easily adapted to your brand.
Contains default dark and light theme with SCSS functions to generate your own themes in a few steps.

## What you'll get

- **Light and Dark** default themes easily customizable
- **35+ 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/components
```

or **NPM**

```bash
npm install @xui/components
```

## 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).