htmx/README.md

2.4 KiB

</> htmx

high power tools for HTML

Gitter Netlify Status Circle CI

introduction

htmx is a set of HTML extensions give you to access to AJAX, WebSockets and Server Sent Events via attributes, allowing you to build modern UI with the simplicity and power of hypertext

htmx is small (~6k min.gz'd), dependency-free, extendable, IE11 compatible & you can try it out quickly, without a huge rewrite

quick start

  <!-- Load from unpkg -->
  <script src="https://unpkg.com/htmx.org@0.0.4"></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

website & docs

https://htmx.org

https://htmx.org/docs

contributing

  • please write code, including tests, in ES5 for IE 11 compatibility
  • please include test cases in /test and docs in /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

haiku

javascript fatigue:
longing for a hypertext
already in hand