UNPKG

4.27 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[![Bundlephobia](https://badgen.net/bundlephobia/dependency-count/htmx.org)](https://bundlephobia.com/result?p=htmx.org)
8[![Bundlephobia](https://badgen.net/bundlephobia/minzip/htmx.org)](https://bundlephobia.com/result?p=htmx.org)
9
10
11## introduction
12
13htmx 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)
15directly 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
19htmx is small ([~10k 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) &
22IE11 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
31By 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.6.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
45The [`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
49htmx is the successor to [intercooler.js](http://intercoolerjs.org)
50
51### installing as a node package
52
53To install using npm:
54
55```
56npm install htmx.org --save
57```
58
59Note there is an old broken package called `htmx`. This is `htmx.org`.
60
61## website & docs
62
63* <https://htmx.org>
64* <https://htmx.org/docs>
65
66## contributing
67
68* please write code, including tests, in ES5 for [IE 11 compatibility](https://stackoverflow.com/questions/39902809/support-for-es6-in-internet-explorer-11)
69* 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)
70* if you are adding a feature, consider doing it as an [extension](https://htmx.org/extensions) instead to
71keep the core htmx code tidy
72* development pull requests should be against the `dev` branch, docs fixes can be made directly against `master`
73* No time? Then [become a sponsor](https://github.com/sponsors/bigskysoftware#sponsors)
74
75### hacking guide
76
77to develop htmx locally, you will need to install the development dependencies:
78
79* `npm install`
80
81and then run a web server in the root (easiest with python):
82
83* `python3 -m http.server
84`
85
86you can then run the test suite by navigating to:
87
88<http://0.0.0.0:8000/test/>
89
90at this point you can modify `/src/htmx.js` to add features, and then add tests in the appropriate area under `/test`
91
92* `/test/index.html` - the root test page from which all other tests are included
93* `/test/attributres` - attribute specific tests
94* `/test/core` - core functionality tests
95* `/test/core/regressions.js` - regresssion tests
96* `/test/ext` - extension tests
97* `/test/manual` - manual tests that cannot be automated
98
99htmx uses the [mocha](https://mochajs.org/) testing framework, the [chai](https://www.chaijs.com/) assertion framework
100and [sinon](https://sinonjs.org/releases/v11.1.1/fake-xhr-and-server/) to mock out AJAX requests. They are all OK.
101
102## haiku
103
104*javascript fatigue:<br/>
105longing for a hypertext<br/>
106already in hand*