blob: b6d5bf106d5f3b96975deccf16f3c0ded03a2db9 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
[](https://htmx.org)
*high power tools for HTML*
[](https://htmx.org/discord)
[](https://app.netlify.com/sites/htmx/deploys)
[](https://bundlephobia.com/result?p=htmx.org)
[](https://bundlephobia.com/result?p=htmx.org)
## introduction
htmx allows you to access [AJAX](https://htmx.org/docs#ajax), [CSS Transitions](https://htmx.org/docs#css_transitions),
[WebSockets](https://htmx.org/docs#websockets) and [Server Sent Events](https://htmx.org/docs#sse)
directly in HTML, using [attributes](https://htmx.org/reference#attributes), so you can build
[modern user interfaces](https://htmx.org/examples) with the [simplicity](https://en.wikipedia.org/wiki/HATEOAS) and
[power](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) of hypertext
htmx is small ([~14k min.gz'd](https://unpkg.com/htmx.org/dist/)),
[dependency-free](https://github.com/bigskysoftware/htmx/blob/master/package.json) &
[extendable](https://htmx.org/extensions)
## 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](https://en.wikipedia.org/wiki/Hypertext)
## quick start
```html
<script src="https://unpkg.com/htmx.org@2.0.4"></script>
<!-- have a button POST a click via AJAX -->
<button hx-post="/clicked" hx-swap="outerHTML">
Click Me
</button>
```
The [`hx-post`](https://htmx.org/attributes/hx-post) and [`hx-swap`](https://htmx.org/attributes/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](http://intercoolerjs.org)
### 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
* <https://htmx.org>
* <https://htmx.org/docs>
## contributing
Want to contribute? Check out our [contribution guidelines](CONTRIBUTING.md)
No time? Then [become a sponsor](https://github.com/sponsors/bigskysoftware#sponsors)
### hacking guide
To develop htmx locally, you will need to install the development dependencies.
Run:
```
npm install
```
Then, run a web server in the root.
This is easiest with:
```
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](https://mochajs.org/) testing framework, the [chai](https://www.chaijs.com/) assertion framework
and [sinon](https://sinonjs.org/releases/v9/fake-xhr-and-server/) to mock out AJAX requests. They are all OK.
You can also run live tests and demo of the WebSockets and Server-Side Events extensions with `npm run ws-tests`
## haiku
*javascript fatigue:<br/>
longing for a hypertext<br/>
already in hand*
|
