Skip to content

Latest commit

 

History

History
106 lines (72 loc) · 4.17 KB

README.md

File metadata and controls

106 lines (72 loc) · 4.17 KB
Raw

</> htmx

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 <a> and <form> 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

  <!-- Load from unpkg -->
  <script src="https://unpkg.com/[email protected]" ></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

  • 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
  • No time? Then become a sponsor

hacking guide

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

  • npm install

and then run a web server in the root (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/attributres - attribute specific tests
  • /test/core - core functionality tests
  • /test/core/regressions.js - regresssion tests
  • /test/ext - extension tests
  • /test/manual - manual tests that cannot be automated

htmx uses the mocha testing framework, the chai assertion frame work, and sinon to mock out AJAX requests. They are all OK.

haiku

javascript fatigue:
longing for a hypertext
already in hand