@squirrel-forge/ui-core/README.md

A collection of interface, classes, functions and abstracts made for the browser and babel compatible.

# @squirrel-forge/ui-core
A collection of interface, classes, functions and abstracts made for the browser and babel compatible.

## Installation

```
npm i @squirrel-forge/ui-core
```

## Usage

```
import { Class, function } from '@squirrel-forge/ui-core';
```

## Documentation
The documentation is also included in the package.

## Table of contents
Package contents listing by language and namespace.

 - Javascript
   - [Abstracts](docs/Abstracts.md)
     - [UiComponent](docs/Abstracts.md#uicomponent)
     - [UiPlugin](docs/Abstracts.md#uiplugin)
     - [UiTemplate](docs/Abstracts.md#uitemplate)
   - [Renderers](docs/Renderers.md)
     - [UiTemplateRenderer](docs/Renderers.md#uitemplaterenderer)
   - [States](docs/States.md)
     - [ComponentStates](docs/States.md#componentstates)
     - [ElementClassStates](docs/States.md#elementclassstates)

## Issues and docs
If you encounter any issues, please report [here](https://github.com/squirrel-forge/ui-core/issues).

---

Check the sourcecode on [github](https://github.com/squirrel-forge/ui-core) for detailed comments.