htmx

htmx - high power tools for HTML

UI Framework
bigskysoftware/htmxhtmx.orghtmx.org

README

[![ htmx](https://raw.githubusercontent.com/bigskysoftware/htmx/master/www/img/htmx_logo.1.png "high power tools for HTML")](https://htmx.org)

high power tools for HTML
Discord Netlify Bundlephobia Bundlephobia


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 (~10k min.gz'd),
dependency-free,
extendable &
IE11 compatible

motivation


* Why should only `` and `
` be able to make HTTP requests?
Why should only click & submit events 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


  1. ``` html
  2.   <script src="https://unpkg.com/htmx.org@1.8.4"></script>
  3.   
  4.   <button hx-post="/clicked" hx-swap="outerHTML">
  5.     Click Me
  6.   </button>
  7. ```

The [hx-post](https://htmx.org/attributes/hx-post) and [hx-swap](https://htmx.org/attributes/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:

  1. ```
  2. npm install htmx.org --save
  3. ```

Note there is an old broken package called htmx.  This is htmx.org.

website & docs


* *

contributing


please write code, including tests, in ES5 for IE 11 compatibility
please include test cases in [/test](https://github.com/bigskysoftware/htmx/tree/dev/test) and docs in [/www](https://github.com/bigskysoftware/htmx/tree/dev/www)
if you are adding a feature, consider doing it as an extension instead to
keep the core htmx code tidy
development pull requests should be against the dev branch, docs fixes can be made directly against master
No time? Then become a sponsor

hacking guide


To develop htmx locally, you will need to install the development dependencies.
Use node 15 and run:

  1. ```
  2. npm install
  3. ```

Then, run a web server in the root.
This is easiest with Python:

  1. ```
  2. python3 -m http.server
  3. ```

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*