htmx

htmx - high power tools for HTML

48,941 stars JavaScript Markdown Skills API Spec #hateoas#html#htmx#hyperscript
AI Prompts & Specs

Repository: bigskysoftware/htmx


Stars: 47834

README.md

![</> htmx](https://htmx.org)

high power tools for HTML

![Discord](https://htmx.org/discord)
![Netlify](https://app.netlify.com/sites/htmx/deploys)
![Bundlephobia](https://bundlephobia.com/result?p=htmx.org)
![Bundlephobia](https://bundlephobia.com/result?p=htmx.org)

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 & 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

html
<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:

text
npm install htmx.org --save

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

website & docs

* <https://htmx.org>
* <https://htmx.org/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:

text
npm install

Then, run a web server in the root.

This is easiest with:

text
npx serve

You can then run the test suite by navigating to:

<http://0.0.0.0:3000/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 the mocha testing framework, the chai assertion framework
and sinon to mock out AJAX requests. They are all OK.

haiku

*javascript fatigue:<br/>
longing for a hypertext<br/>
already in hand*