@zeainc/zea-ux/README.md

Zea UX

# Zea UX

[![NPM Package][npm]][npm-url]
[![Build Size][build-size]][build-size-url]
[![NPM Downloads][npm-downloads]][npmtrends-url]

# Introduction
There are a features that are user specific, not something everyone needs; therefore we created the Zea Ux plug-in. It adds powerful features to the engine, that enrich the user experience like creation tools, UndoRedo System, etc.
</br>
</br>
</br>

# Documentation
Full documentation with concepts, tutorials, live examples, API documentation and more; can be found at the zea ux docs site:
[https://docs.zea.live/zea-ux](https://docs.zea.live/zea-ux)

These docs allow developers to get started with the Zea UX by downloading free and open-source demo content and using Zea's publicly distributed client-side libraries.
</br>
</br>
</br>

# Licensing
The Zea UX plug-in is under a [`MIT`](https://en.wikipedia.org/wiki/MIT_License) license.
</br>
</br>
</br>

# Add it to your project
The process to add Zea UX to your projects is easy. 

## *Using CDNs*
For static websites or quick implementation you can always use CDNs like JsDelivr or Unpkg:

### *JsDelivr*
```html
<script crossorigin src="https://cdn.jsdelivr.net/npm/@zeainc/zea-ux/dist/index.umd.min.js"></script>
```
### *Unpkg*
```html
<script crossorigin src="https://unpkg.com/@zeainc/zea-ux/dist/index.umd.js"></script>
```
### *Use it*
```html
<script>
  const { UndoRedoManager } = globalThis.zeaUx
</script>
```

## *As a Module*
But if you want to use it like a module, then install the package in your project using `npm` or `yarn`:

```bash
npm i @zeainc/zea-ux
## Or
yarn add @zeainc/zea-ux
```

### *Use it*
```javascript
import { UndoRedoManager } from '@zeainc/zea-ux'
// ...
```
</br>
</br>
</br>

# Dependencies
This plug-in depends on [ZeaEngine](https://docs.zea.live/zea-engine). So, if you're using CDNs, make sure to import it before UX.
</br>

> For questions on licensing, please fill out the contact form on our website: [_zea.live_](https://www.zea.live/contact-us)

[npm]: https://badge.fury.io/js/%40zeainc%2Fzea-ux.svg
[npm-url]: https://www.npmjs.com/package/@zeainc/zea-ux
[build-size]: https://badgen.net/bundlephobia/minzip/@zeainc/zea-ux
[build-size-url]: https://bundlephobia.com/result?p=@zeainc/zea-ux
[npm-downloads]: https://img.shields.io/npm/dw/@zeainc/zea-ux
[npmtrends-url]: https://www.npmtrends.com/@zeainc/zea-ux