usml
v0.1.1-beta.0
Published
UnScriptML is a lightweight JavaScript library designed to streamline web development by reducing the reliance on embedded JavaScript within HTML files. This library empowers developers to create dynamic and interactive web elements using simple, clean, a
Downloads
1
Readme
UnScript Markup Language
USML
is a lightweight JavaScript library designed to streamline web development by reducing the reliance on embedded JavaScript within HTML files. This library empowers developers to create dynamic and interactive web elements using simple, clean, and script-free HTML markup.
Features
- Script-Free HTML UnScriptML 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 UnScriptML is compatible with modern web browsers, ensuring a consistent user experience.
- Lightweight The library is minimal in size, minimizing the impact on page load times.
Getting Started
Include the USML library in your HTML document:
<script src="usml.js"></script>
Use USML attributes within your HTML elements to add interactivity:
<body $load="get:/pages" $append="innerHTML"> <!-- Your HTML body --> </body>
Basic
USML 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 two(3) parts, a declaration
$action
, an assignment
=
and a handler
"event:selector"
.
- A
$
sign to define/accessUSML
inspired by jquery - A
action
to be performed on the element - A
event
to emit anUSMLEvent
or trigger anhttp
request inspired by htmx - 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
USML provides a range of attributes to enhance interactivity, such as $click
, $hover
, $hide
, $toggle
, and more. These attributes allow you to define behaviors without the need for JavaScript code.
<button $click="show:#hello">Show message!</button>
<div id="hello">Hello, USML!</div>
Contributions
We welcome contributions from the community to improve USML. If you encounter issues, have ideas for enhancements, or would like to contribute to the project, please visit our GitHub repository.
License
USML is distributed under the MIT License. Feel free to use, modify, and distribute this library in your projects.
Acknowledgments
USML stands on the shoulders of giants, drawing inspiration from jquery, htmx, angularjs and the need for cleaner more maintainable web code. We acknowledge the invaluable contributions of these innovative frameworks in shaping our journey towards excellence. Their pioneering work has illuminated our path, empowering us to reach new heights in our mission. We thank the open-source community for their contributions and support in making this project possible.