Zea UX

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.

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

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.

Licensing

The Zea UX plug-in is under a MIT license.

Add it to your project

The process to add Zea UX to your projects is easy.

Development Setup

This project depends on private @zeainc packages hosted on GitHub Packages. To install dependencies locally, you need to configure authentication in your global npm configuration:

1. Create a GitHub Personal Access Token (classic) with read:packages scope:

   • Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
   • Generate new token with read:packages permission

2. Add the token to your global ~/.npmrc file:

   echo "//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN" >> ~/.npmrc

3. Now you can install dependencies:

   yarn install

Note: The authentication token should only be in your global ~/.npmrc, never commit tokens to the repository.

Using CDNs

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

JsDelivr

<script crossorigin src="https://cdn.jsdelivr.net/npm/@zeainc/zea-ux/dist/index.umd.min.js"></script>

Unpkg

<script crossorigin src="https://unpkg.com/@zeainc/zea-ux/dist/index.umd.js"></script>

Use it

<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:

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

Use it

import { UndoRedoManager } from '@zeainc/zea-ux'
// ...

Dependencies

This plug-in depends on ZeaEngine. So, if you're using CDNs, make sure to import it before UX.

For questions on licensing, please fill out the contact form on our website: zea.live