https://github.com/8tentaculos/rasti
Rasti is a minimalistic JavaScript library for building user interfaces.
https://github.com/8tentaculos/rasti
backbonejs component es6 javascript javascript-library lightweight minimalistic mvc ui
Last synced: 3 months ago
JSON representation
Rasti is a minimalistic JavaScript library for building user interfaces.
- Host: GitHub
- URL: https://github.com/8tentaculos/rasti
- Owner: 8tentaculos
- License: mit
- Created: 2018-08-08T20:22:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-28T21:39:57.000Z (over 1 year ago)
- Last Synced: 2024-09-28T21:55:24.713Z (over 1 year ago)
- Topics: backbonejs, component, es6, javascript, javascript-library, lightweight, minimalistic, mvc, ui
- Language: JavaScript
- Homepage: http://rasti.js.org
- Size: 1.13 MB
- Stars: 24
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Modern MVC for building user interfaces
**Rasti is a lightweight MVC library for building fast, reactive user interfaces.**
It provides declarative, composable **components** for building state-driven UIs.
Its low-level MVC core, inspired by **Backbone.js**’s architecture, provides **models**, **views** and **event emitters** as the fundamental building blocks.
[](https://app.travis-ci.com/8tentaculos/rasti)
[](https://www.npmjs.com/package/rasti)
[](https://unpkg.com/rasti/dist/rasti.min.js)
[](https://www.npmjs.com/package/rasti)
[](https://www.jsdelivr.com/package/npm/rasti)
## Key Features
- **Declarative Components** 🌟
Build dynamic UI components using intuitive template literals.
- **Event Delegation** 🎯
Simplify event handling with built-in delegation.
- **Model-View Binding** 🔗
Keep your UI and data in sync with ease.
- **Server-Side Rendering** 🌐
Render as plain text for server-side use or static builds.
- **Lightweight and Fast** ⚡
Minimal overhead with efficient rendering.
- **Legacy Compatibility** 🕰️
Seamlessly integrates into existing **Backbone.js** legacy projects.
- **Standards-Based** 📐
Built on modern web standards, no tooling required.
## Getting Started
### Installing via npm
```bash
$ npm install rasti
```
```javascript
import { Model, Component } from 'rasti';
```
### Using ES modules via CDN
```javascript
import { Model, Component } from 'https://esm.run/rasti';
```
### Using a UMD build via CDN
Include **Rasti** directly in your HTML using a CDN. Available UMD builds:
- [https://cdn.jsdelivr.net/npm/rasti/dist/rasti.js](https://cdn.jsdelivr.net/npm/rasti/dist/rasti.js)
- [https://cdn.jsdelivr.net/npm/rasti/dist/rasti.min.js](https://cdn.jsdelivr.net/npm/rasti/dist/rasti.min.js)
```html
```
The UMD build exposes the `Rasti` global object:
```javascript
const { Model, Component } = Rasti;
```
### Create a `Component`
```javascript
// Define a Timer component that displays the number of seconds from the model.
const Timer = Component.create`
Seconds: ${({ model }) => model.seconds}
`;
// Create a model to store the seconds.
const model = new Model({ seconds : 0 });
// Mount the Timer component to the body and pass the model as an option.
Timer.mount({ model }, document.body);
// Increment the `seconds` property of the model every second.
// Only the text node inside the gets updated on each render.
setInterval(() => model.seconds++, 1000);
```
[Try it on CodePen](https://codepen.io/8tentaculos/pen/gOQxaOE?editors=0010)
### Adding sub components
```javascript
// Define the routes for the navigation menu.
const routes = [
{ label : 'Home', href : '#' },
{ label : 'Faq', href : '#faq' },
{ label : 'Contact', href : '#contact' },
];
// Create a Link component for navigation items.
const Link = Component.create`
${({ props }) => props.renderChildren()}
`;
// Create a Navigation component that renders Link components for each route.
const Navigation = Component.create`
${({ props, partial }) => props.routes.map(
({ label, href }) => partial`<${Link} href="${href}">${label}${Link}>`
)}
`;
// Create a Main component that includes the Navigation and displays the current route's label as the title.
const Main = Component.create`
<${Navigation} routes="${({ props }) => props.routes}" />
${({ model, props }) => props.routes.find(
({ href }) => href === (model.location || '#')
).label}
`;
// Initialize a model to store the current location.
const model = new Model({ location : document.location.hash });
// Update the model's location state when the browser's history changes.
window.addEventListener('popstate', () => model.location = document.location.hash);
// Mount the Main component to the body, passing the routes and model as options.
Main.mount({ routes, model }, document.body);
```
[Try it on CodePen](https://codepen.io/8tentaculos/pen/dyBMNbq?editors=0010)
### Adding event listeners
```javascript
// Create a model to store the counter value.
const model = new Model({ count : 0 });
// Create a Counter component with increment and decrement buttons.
const Counter = Component.create`
Counter: ${({ model }) => model.count}
Increment
Decrement
`;
// Mount the Counter component to the body and pass the model as an option.
Counter.mount({ model }, document.body);
// Event listeners are bound to 'this' and use delegation from the root element.
// When buttons are clicked, only the text node gets updated, not the entire component.
```
[Try it on CodePen](https://codepen.io/8tentaculos/pen/XJXVQOR?editors=0010)
## Why Choose **Rasti**?
**Rasti** is built for developers who want a simple yet powerful way to create UI components without the complexity of heavy frameworks. Whether you're building a high-performance dashboard, or embedding a lightweight widget, **Rasti** lets you:
- **Skip the Setup**
No installations, no build tools—just load it and start coding.
- **Lightweight and Efficient**
Minimal footprint with optimized performance, ensuring smooth updates.
- **Just the Right Abstraction**
Keeps you close to the DOM with no over-engineering. Fully hackable—if you're curious about how something works, just check the source code.
## Example
You can find a sample **TODO application** in the [example folder](https://github.com/8tentaculos/rasti/tree/master/example/todo) of the **Rasti** [GitHub repository](https://github.com/8tentaculos/rasti). This example serves as a great starting point for your own projects. Try it live [here](https://rasti.js.org/example/todo/index.html).
## API Documentation
For detailed information on how to use **Rasti**, refer to the [API documentation](/docs/api.md).
## Working with LLMs
For those working with LLMs, there is an [AI Agents reference guide](/docs/AGENTS.md) that provides API patterns, lifecycle methods, and best practices, optimized for LLM context. You can share this guide with AI assistants to help them understand **Rasti**'s architecture and component APIs.
## Version History
We strive to minimize breaking changes between major versions. However, if you're migrating between major versions, please refer to the release notes below for details on any breaking changes and migration tips.
- **[v4.0.0](https://github.com/8tentaculos/rasti/releases/tag/v4.0.0)**
- **[v3.0.0](https://github.com/8tentaculos/rasti/releases/tag/v3.0.0)**
- **[v2.0.0](https://github.com/8tentaculos/rasti/releases/tag/v2.0.0)**
- **[v1.0.0](https://github.com/8tentaculos/rasti/releases/tag/v1.0.0)**
## License
**Rasti** is open-source and available under the [MIT License](LICENSE).
## Contributing
Contributions are welcome! Share feature ideas or report bugs on our [GitHub Issues page](https://github.com/8tentaculos/rasti/issues).