bigskysoftware/htmx
</> htmx - high power tools for HTML
Build with Backblaze B2
SDKs, agent skills, IDE extensions, and reference pipelines from Backblaze Labs. All open source.
Loading star history...
Use Cases & Benefits
- Enables dynamic web interfaces by extending HTML with AJAX, CSS transitions, WebSockets, and Server Sent Events using custom attributes.
- Offers a lightweight, dependency-free, and extensible way to build modern hypertext-driven user interfaces without complex JavaScript frameworks.
- Use for enhancing traditional HTML forms and links to perform asynchronous HTTP requests with fine-grained control over events and methods.
- Use for creating real-time web applications that leverage WebSockets or Server Sent Events directly through HTML attributes.
- Use for developers seeking to progressively enhance server-rendered pages with minimal client-side code and maintain hypermedia-driven RESTful interactions.
About htmx
high power tools for HTML
introduction
htmx allows you to access AJAX, CSS Transitions, WebSockets and Server Sent Events directly in HTML, using attributes, so you can build modern user interfaces with the simplicity and power of hypertext
htmx is small (~14k min.gz'd), dependency-free & extendable
motivation
- Why should only
<a>and<form>be able to make HTTP requests? - Why should only
click&submitevents trigger them? - Why should only GET & POST be available?
- Why should you only be able to replace the entire screen?
By removing these arbitrary constraints htmx completes HTML as a hypertext
quick start
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/htmx.min.js"></script>
<!-- have a button POST a click via AJAX -->
<button hx-post="/clicked" hx-swap="outerHTML">
Click Me
</button>
The hx-post and hx-swap attributes tell htmx:
"When a user clicks on this button, issue an AJAX request to /clicked, and replace the entire button with the response"
htmx is the successor to intercooler.js
installing as a node package
To install using npm:
npm install htmx.org --save
Note there is an old broken package called htmx. This is htmx.org.
website & docs
contributing
Want to contribute? Check out our contribution guidelines
No time? Then become a sponsor
hacking guide
To develop htmx locally, you will need to install the development dependencies.
Run:
npm install
Then, run a web server in the root.
This is easiest with:
npx serve
You can then run the test suite by navigating to:
At this point you can modify /src/htmx.js to add features, and then add tests in the appropriate area under /test.
/test/index.html- the root test page from which all other tests are included/test/attributes- attribute specific tests/test/core- core functionality tests/test/core/regressions.js- regression tests/test/ext- extension tests/test/manual- manual tests that cannot be automated
htmx uses the mocha testing framework, the chai assertion framework and sinon to mock out AJAX requests. They are all OK.
haiku
javascript fatigue:
longing for a hypertext
already in hand
Discover Repositories
Search across tracked repositories by name or description