UNPKG

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