mirror of
https://github.com/bigskysoftware/htmx.git
synced 2025-09-28 05:21:18 +00:00
58 lines
2.1 KiB
Markdown
58 lines
2.1 KiB
Markdown
---
|
|
layout: layout.njk
|
|
title: </> htmx - high power tools for html
|
|
---
|
|
|
|
<div class="dark-hero full-width" classes="add appear">
|
|
<span class="logo dark"><<a>/</a>> <span class="no-mobile">htm<a>x</a></span></span>
|
|
<sub class="no-mobile"><i>high power tools for HTML</i></sub>
|
|
</div>
|
|
|
|
|
|
## 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 ([~9k 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) &
|
|
IE11 compatible
|
|
|
|
## 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
|
|
<!-- Load from unpkg -->
|
|
<script src="https://unpkg.com/htmx.org@1.3.1"></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)
|
|
|
|
Read the [docs introduction](/docs#introduction) for a more in-depth... introduction.
|
|
|
|
## haiku
|
|
|
|
*javascript fatigue:<br/>
|
|
longing for a hypertext<br/>
|
|
already in hand*
|