1 | [](https://htmx.org)
|
2 |
|
3 | *high power tools for HTML*
|
4 |
|
5 | [](https://htmx.org/discord)
|
6 | [](https://app.netlify.com/sites/htmx/deploys)
|
7 | [](https://bundlephobia.com/result?p=htmx.org)
|
8 | [](https://bundlephobia.com/result?p=htmx.org)
|
9 |
|
10 |
|
11 | ## introduction
|
12 |
|
13 | htmx allows you to access [AJAX](https://htmx.org/docs#ajax), [CSS Transitions](https://htmx.org/docs#css_transitions),
|
14 | [WebSockets](https://htmx.org/docs#websockets) and [Server Sent Events](https://htmx.org/docs#sse)
|
15 | directly in HTML, using [attributes](https://htmx.org/reference#attributes), so you can build
|
16 | [modern user interfaces](https://htmx.org/examples) with the [simplicity](https://en.wikipedia.org/wiki/HATEOAS) and
|
17 | [power](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) of hypertext
|
18 |
|
19 | htmx is small ([~9k min.gz'd](https://unpkg.com/htmx.org/dist/)),
|
20 | [dependency-free](https://github.com/bigskysoftware/htmx/blob/master/package.json),
|
21 | [extendable](https://htmx.org/extensions) &
|
22 | IE11 compatible
|
23 |
|
24 | ## motivation
|
25 |
|
26 | * Why should only `<a>` and `<form>` be able to make HTTP requests?
|
27 | * Why should only `click` & `submit` events trigger them?
|
28 | * Why should only GET & POST be available?
|
29 | * Why should you only be able to replace the *entire* screen?
|
30 |
|
31 | By removing these arbitrary constraints htmx completes HTML as a
|
32 | [hypertext](https://en.wikipedia.org/wiki/Hypertext)
|
33 |
|
34 | ## quick start
|
35 |
|
36 | ```html
|
37 | <!-- Load from unpkg -->
|
38 | <script src="https://unpkg.com/htmx.org@1.3.0" ></script>
|
39 | <!-- have a button POST a click via AJAX -->
|
40 | <button hx-post="/clicked" hx-swap="outerHTML">
|
41 | Click Me
|
42 | </button>
|
43 | ```
|
44 |
|
45 | The [`hx-post`](https://htmx.org/attributes/hx-post) and [`hx-swap`](https://htmx.org/attributes/hx-swap) attributes tell htmx:
|
46 |
|
47 | > "When a user clicks on this button, issue an AJAX request to /clicked, and replace the entire button with the response"
|
48 |
|
49 | htmx is the successor to [intercooler.js](http://intercoolerjs.org)
|
50 |
|
51 | ## website & docs
|
52 |
|
53 | * <https://htmx.org>
|
54 | * <https://htmx.org/docs>
|
55 |
|
56 | ## contributing
|
57 |
|
58 | * please write code, including tests, in ES5 for [IE 11 compatibility](https://stackoverflow.com/questions/39902809/support-for-es6-in-internet-explorer-11)
|
59 | * 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)
|
60 | * if you are adding a feature, consider doing it as an [extension](https://htmx.org/extensions) instead to
|
61 | keep the core htmx code tidy
|
62 | * development pull requests should be against the `dev` branch, docs fixes can be made directly against `master`
|
63 |
|
64 | ## haiku
|
65 |
|
66 | *javascript fatigue:<br/>
|
67 | longing for a hypertext<br/>
|
68 | already in hand*
|