https://github.com/bigskysoftware/htmx
</> htmx - high power tools for HTML
https://github.com/bigskysoftware/htmx
hateoas html htmx hyperscript javascript rest
Last synced: 6 months ago
JSON representation
</> htmx - high power tools for HTML
- Host: GitHub
- URL: https://github.com/bigskysoftware/htmx
- Owner: bigskysoftware
- License: other
- Created: 2020-04-13T16:17:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-01T06:33:10.000Z (6 months ago)
- Last Synced: 2025-05-05T15:11:44.921Z (6 months ago)
- Topics: hateoas, html, htmx, hyperscript, javascript, rest
- Language: JavaScript
- Homepage: https://htmx.org
- Size: 92.6 MB
- Stars: 44,482
- Watchers: 213
- Forks: 1,432
- Open Issues: 615
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - bigskysoftware/htmx - \</> htmx - high power tools for HTML (JavaScript)
- awesome - bigskysoftware/htmx - \</> htmx - high power tools for HTML (JavaScript)
- awesome - bigskysoftware/htmx - \</> htmx - high power tools for HTML (JavaScript)
- awesome-ccamel - bigskysoftware/htmx - </> htmx - high power tools for HTML (JavaScript)
- awesome-github-star - htmx - high power tools for HTML | bigskysoftware | 21516 | (JavaScript)
- awesome-list - htmx - high power tools for HTML | bigskysoftware | 4270 | (JavaScript)
- awesome-htmx - GitHub
- StarryDivineSky - bigskysoftware/htmx
- awesome-starred - bigskysoftware/htmx - </> htmx - high power tools for HTML (JavaScript)
- awesome-starred - bigskysoftware/htmx - </> htmx - high power tools for HTML (JavaScript)
- stars - bigskysoftware/htmx - </> htmx - high power tools for HTML (JavaScript)
- stars - bigskysoftware/htmx - </> htmx - high power tools for HTML (JavaScript)
- awesome-starred - bigskysoftware/htmx - </> htmx - high power tools for HTML (javascript)
README
[](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
By removing these arbitrary constraints htmx completes HTML as a
[hypertext](https://en.wikipedia.org/wiki/Hypertext)
## quick start
```html
Click Me
```
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
*
*
## 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:
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:
longing for a hypertext
already in hand*