Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mackignacio/uxml
Unscripted Extended Markup Language
https://github.com/mackignacio/uxml
Last synced: 5 days ago
JSON representation
Unscripted Extended Markup Language
- Host: GitHub
- URL: https://github.com/mackignacio/uxml
- Owner: mackignacio
- License: other
- Created: 2023-09-05T13:42:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-12T06:21:57.000Z (over 1 year ago)
- Last Synced: 2024-12-15T11:37:06.797Z (23 days ago)
- Language: TypeScript
- Homepage: https://mackignacio.github.io/uxml/
- Size: 464 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Unscripted eXtended Markup Language (UXML)
**`UXML`** a lightweight, script-free component library designed specifically for web development within HTML. Whether you're a seasoned developer or new to web development, UXML simplifies the creation of interactive web applications without the need for complex JavaScript frameworks. You can create dynamic web components effortlessly without the need for any JavaScript code. With UXML, you can enhance user interfaces, handle user interactions, and build feature-rich web applications while working within the familiar HTML structure.
## Features
- **Script-Free HTML**
UXML enables the creation of dynamic web content directly within HTML, eliminating the need for inline JavaScript.
- **Simplified Interactivity**
Easily add interactive features to your web pages using HTML attributes and minimal configuration.
- **Cross-Browser Compatibility**
UXML is compatible with modern web browsers, ensuring a consistent user experience.
- **Lightweight**
UXML is incredibly lightweight, weighing in **(~3k min.js gzip'd)** size, no dependency, very extendable, compatible to all major browser and `90%` smaller than popular libraries like [react](https://react.dev/).
- **No Virtual DOM**
UXML doesn't rely on a virtual DOM. This results in a more efficient and simplified rendering process.
- **Shallow Learning Curve**
UXML offers a shallow learning curve, making it accessible to developers of all skill levels. If you know **HTML**, you can start using UXML right away.
## Getting Started
1. Include the UXML library in your HTML document:
```html
```
2. Use UXML attributes within your HTML elements to add interactivity:
```html
```
## Basic
UXML uses a simple syntax **`$action="event:selector"`** similar on how we do a basic `onclick="click()"` event handler in plain HTML. This is consist of three(**3**) parts, a _declaration_ **`$action`**, an _assignment_ **`=`** and a _handler_ **`"event:selector"`**.
- A **`$`** sign to define/access `UXML` inspired by [jquery](https://jquery.com/)
- A **`action`** to be performed on the element inspired by [angularjs](https://angularjs.org/)
- A **`event`** to emit an `UXMLEvent` or trigger an `http` request inspired by [htmx](https://htmx.org/)
- A **`:`** to separate **event** and **selector**
- A **`selector`** to "**query**" HTML elements or "**value**" of a given event i.e. `url` for http request
## Usage
UXML provides a range of attributes to enhance interactivity, such as `$click`, `$submit`, `$load`, `$component` and more. These attributes allow you to define behaviors without the need for JavaScript code.
```html
Show message!
Hello, UXML!
```
## Contributions
We welcome contributions from the community to improve UXML. If you have ideas for improvements or encounter any issues, please consider opening an issue or submitting a pull request on our **[GitHub repository](https://github.com/mackignacio/uxml/issues)**.
## License
UXML is distributed under the MIT License. Feel free to use, modify, and distribute this library in your projects.
## Acknowledgments
UXML stands on the shoulders of giants, drawing inspiration from [jquery](https://jquery.com/), [htmx](https://htmx.org/), [angularjs](https://angularjs.org/) and the need for more simplified, cleaner, and maintainable web code. Their pioneering work has illuminated our path, empowering us to develop this project. We thank the open-source community for their contributions and support in making this project possible.