Skip to content
/ zuix Public

zuix.js is a JavaScript library for creating component-based websites and applications.

License

Notifications You must be signed in to change notification settings

zuixjs/zuix

Repository files navigation

zUIx.js logo

zUIx.js

A lightweight JavaScript library for creating amazing component-based websites and applications.

NPM Version License Documentation


zUIx.js is a component-based JavaScript framework for building modern web user interfaces. It's designed to be lightweight, fast, and easy to learn, allowing you to create reusable components with clean HTML, CSS, and JavaScript.

Features

  • Component-Based: Build encapsulated components that manage their own state and logic.
  • Lazy Loading: Components are loaded on-demand, improving initial page load performance.
  • Lightweight: A small footprint keeps your application fast and lean.
  • No Build Step Required: Can be used directly in the browser without a complex build setup.
  • TypeScript Support: Full type definitions for a better development experience with IntelliSense.

Installation

You can add zuix-dist to your project using npm:

npm install zuix-dist

Quick Start

1. In Plain JavaScript (Browser)

Include the library in your HTML file and start creating components.

<!DOCTYPE html>
<html>
<head>
  <!-- ... -->
  <script src="path/to/zuix-dist/js/zuix.min.js"></script>
</head>
<body>
  
  <div z-load="path/to/my-component"></div>

</body>
</html>

2. With a Bundler (like Webpack) and TypeScript

zuix-dist includes full TypeScript definitions. You can import it as an ES module.

import zuix from 'zuix-dist';

// Now you can use the 'zuix' global object with full type support
// For example, to load a component dynamically:

const myComponent = zuix.load('path/to/my-component', {
  view: document.getElementById('my-container'),
  model: {
    message: 'Hello from TypeScript!'
  }
});

Contributing

We welcome contributions! Please see the CONTRIBUTING.md document for guidelines on how to submit bug reports, feature requests, and pull requests.

About

zuix.js is a JavaScript library for creating component-based websites and applications.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published

Contributors 2

  •  
  •