uixThe UIX Framework

uix.unyt.org    •    a unyt.org project

What is UIX?

UIX is an open-source full-stack framework for developing reactive web apps with restorable and shared state. UIX runs on a deno backend and supports both single- and multi page applications with frontend or server-side rendering and hydration.

The DATEX JavaScript Library acts as the backbone of UIX, providing useful functionality such as reactivity and cross-device data exchange. In contrast to frameworks like React, UIX provides direct wiring to the DOM for reactivity and does not need a virtual DOM.

There are many ways to create UIX applications:

• using the TypeScript UIX Library and JSX (focus of the documentation)
• defining UIX states with DATEX
• using the UIX Web Editor (still in development)

The UIX library is designed with a modular approach that makes it easy for developers to add custom components and logic as needed.

Main features

• Cross-network reactivity
• Server side rendering with partial hydration
• Hybrid backend/frontend routing
• Cross-realm imports
• Shared memory
• JSX support
• Reusable web components
• And many more...

UIX aims to simplify all phases of the app development cycle, including design, development, testing and distribution, in order to make the developer experience as convenient as possible. This is why UIX ships with integrated features such as:

• Testing library
• Stage management
• Automated deployment
• Version management
• Hot reloading

Documentation

[!NOTE] You can find all UIX documentation and resources on docs.unyt.org. Please be aware that the documentation is work in progress and may change in the future.

1. Getting Started
2. Imports
3. JSX
4. Components
5. Entrypoints and Routing
6. Component States
7. Persistent Contexts
8. Rendering Methods
9. Configuration
10. Localization
11. Functions and Contexts
12. Styles and Themes
13. Shadow DOM
14. Utility Functions
15. Deployment
16. HTTP Tunneling
17. Plugins
18. Rendering
19. App Communication

Templates and Examples

Feel free to browse a collection of UIX projects on uix.unyt.org/templates.

• Template Hello UIX
• Template Base
• Template Routing
• Template Deployment

• Example Localization
• Example Simple Messenger
• Example Shopping List
• Example Website Screenshot Tool
• Example Tic-Tac-Toe
• Example Weather App
• Example Artwall
• Example Video Call

Browsers support

Certain features of UIX are also supported in legacy browser versions. The following overview is for general guidance in order to show the major browsers and their minimum version number required to use all of UIX's features.

Chrome	Edge	Firefox	Safari	iOS Safari	Samsung	Opera
Chrome 120+	Edge 120+	Firefox 117+	Safari 17.5+	Safari 17.5+	unknown	unknown

UIX DOM

The UIX full-stack framework is built on top of UIX DOM, a standalone library that allows you to define reactive DOM elements on the frontend and backend.

The full-stack UIX framework provides many more features, but if you just need a basic reactive DOM library, you can take a look at UIX DOM.

Contributing

We welcome every contribution!
Please take a look at the development guidelines and the unyt.org contribution guidlines.

Connect with us

Check out our Blog!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Benedikt Strehle 🐛 🖋 📖 🎨 🤔 🚧 ⚠️ 📆 💻

Jonas Strehle 🎨 💻 📖 🤔 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

_{© unyt 2024 • unyt.org}