Repository files navigation

high power tools for HTML

htmx allows you to accessAJAX,CSS Transitions,WebSockets andServer Sent Eventsdirectly in HTML, usingattributes, so you can buildmodern user interfaces with thesimplicity andpower of hypertext

htmx is small (~10k min.gz'd),dependency-free,extendable &IE11 compatible

• Why should only<a> and<form> be able to make HTTP requests?
• Why should onlyclick &submit events trigger them?
• Why should only GET & POST be available?
• Why should you only be able to replace theentire screen?

By removing these arbitrary constraints htmx completes HTML as ahypertext

<scriptsrc="https://unpkg.com/htmx.org@1.9.0"></script><!-- have a button POST a click via AJAX --><buttonhx-post="/clicked"hx-swap="outerHTML">    Click Me</button>

Thehx-post andhx-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 tointercooler.js

To install using npm:

npm install htmx.org --save

Note there is an old broken package calledhtmx. This ishtmx.org.

• https://htmx.org
• https://htmx.org/docs

• please write code, including tests, in ES5 forIE 11 compatibility
• please include test cases in/test and docs in/www
• if you are adding a feature, consider doing it as anextension instead tokeep the core htmx code tidy
• development pull requests should be against thedev branch, docs fixes can be made directly againstmaster
• No time? Thenbecome a sponsor

To develop htmx locally, you will need to install the development dependencies.

Requires Python and Node 15.

Run:

npm install

Then, run a web server in the root.

This is easiest with Python:

python3 -m http.server

You can then run the test suite by navigating to:

http://0.0.0.0:8000/test/

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 themocha testing framework, thechai assertion frameworkandsinon to mock out AJAX requests. They are all OK.

javascript fatigue:
longing for a hypertext
already in hand