mirror of
https://github.com/bigskysoftware/htmx.git
synced 2025-09-28 13:31:06 +00:00
131 lines
5.5 KiB
Markdown
131 lines
5.5 KiB
Markdown
+++
|
|
insert_anchor_links = "left"
|
|
+++
|
|
|
|
<div class="dark-hero full-width" classes="add appear">
|
|
<span class="logo dark"><<span class="blue">/</span>> <span class="no-mobile">htm<span class="blue">x</span></span></span>
|
|
<sub class="no-mobile"><i>high power tools for HTML</i></sub>
|
|
</div>
|
|
|
|
<div style="border: 1px solid lightgrey; margin:24px;padding:12px;border-radius: 8px; background-color: whitesmoke; filter: drop-shadow(3px 3px darkgray)">
|
|
<b>NEWS:</b> We are excited to <a href="/posts/2023-06-06-htmx-github-accelerator/">announce</a> that htmx has been accepted into the first class of the <a href="https://accelerator.github.com/">GitHub Open Source Accelerator!</a>
|
|
</div>
|
|
|
|
<h2>introduction</h2>
|
|
|
|
htmx gives you access to [AJAX](@/docs.md#ajax), [CSS Transitions](@/docs.md#css_transitions), [WebSockets](@/docs.md#websockets) and [Server Sent Events](@/docs.md#sse)
|
|
directly in HTML, using [attributes](@/reference.md#attributes), so you can build
|
|
[modern user interfaces](@/examples/_index.md) 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](@/extensions/_index.md),
|
|
IE11 compatible & has **reduced** code base sizes by [67% when compared with react](@/essays/a-real-world-react-to-htmx-port.md)
|
|
|
|
<h2>motivation</h2>
|
|
|
|
* Why should only [`<a>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) and [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) be able to make HTTP requests?
|
|
* Why should only [`click`](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) & [`submit`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event) events trigger them?
|
|
* Why should only [`GET`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) & [`POST`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) methods be [available](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)?
|
|
* 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)
|
|
|
|
<h2>quick start</h2>
|
|
|
|
```html
|
|
<script src="https://unpkg.com/htmx.org@1.9.10"></script>
|
|
<!-- have a button POST a click via AJAX -->
|
|
<button hx-post="/clicked" hx-swap="outerHTML">
|
|
Click Me
|
|
</button>
|
|
```
|
|
|
|
The [`hx-post`](@/attributes/hx-post.md) and [`hx-swap`](@/attributes/hx-swap.md) attributes on
|
|
this button tell htmx:
|
|
|
|
> "When a user clicks on this button, issue an AJAX request to /clicked, and replace the entire button with the HTML response"
|
|
|
|
htmx is the successor to [intercooler.js](http://intercoolerjs.org)
|
|
|
|
Read the [docs introduction](@/docs.md#introduction) for a more in-depth... introduction.
|
|
|
|
<h2><a name='book'></a>book</h2>
|
|
|
|
We are happy to announce the release of [Hypermedia Systems](https://hypermedia.systems), a book on how to build
|
|
[Hypermedia-Driven Applications](@/essays/hypermedia-driven-applications.md) using htmx & more:
|
|
|
|
<div style="text-align: center;padding: 24px">
|
|
<a href="https://www.amazon.com/dp/B0C9S88QV6/ref=sr_1_1?crid=1P0I3GXQK32TN"><img src="/img/hypermedia-systems.png" alt="hypermedia systems"></a>
|
|
</div>
|
|
|
|
<h2>sponsors <iframe src="https://github.com/sponsors/bigskysoftware/button" title="Sponsor htmx" height="32" width="114" style="border: 1px solid gray; border-radius: 12px; float:right"></iframe></h2>
|
|
|
|
|
|
htmx development can be supported via [GitHub Sponsors](https://github.com/sponsors/bigskysoftware?o=esb)
|
|
|
|
|
|
Thank you to all our generous <a href="https://github.com/sponsors/bigskysoftware?o=esb">supporters</a>, including:
|
|
|
|
<style>
|
|
#sponsor-table td {
|
|
text-align: center;
|
|
padding: 16px;
|
|
min-height: 100px;
|
|
}
|
|
|
|
@media only screen and (max-width: 760px) {
|
|
|
|
/* Force table to not be like tables anymore */
|
|
table, thead, tbody, th, td, tr {
|
|
display: block;
|
|
}
|
|
|
|
}
|
|
|
|
</style>
|
|
<div style="overflow-x: auto">
|
|
<table id="sponsor-table">
|
|
<tr>
|
|
<td>
|
|
<a href="https://www.jetbrains.com"><img src="/img/jetbrains.png" alt="Jetbrains" style="max-width:30%;min-width:200px;"></a>
|
|
</td>
|
|
<td>
|
|
<a href="https://github.blog/2023-04-12-github-accelerator-our-first-cohort-and-whats-next"><img src="/img/Github_Logo.png" alt="GitHub" style="max-width:30%;min-width:200px;"></a>
|
|
</td>
|
|
<tr>
|
|
<td>
|
|
<a href="https://www.commspace.co.za"><img src="/img/commspace.svg" alt="commspace" style="width:100%;max-width:400px"></a>
|
|
</td>
|
|
<td>
|
|
<a href="https://craftcms.com"><img src="/img/logo-craft-cms.svg" alt="craft cms" style="width:90%;max-width:200px"></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="https://buttercms.com/?utm_campaign=sponsorship&utm_medium=banner&utm_source=htmxhome">
|
|
<img src="/img/butter-cms.svg" alt="ButterCMS" style="width:100%;max-width:200px">
|
|
</a>
|
|
</td>
|
|
<td>
|
|
<a href="https://black.host">
|
|
<img src="/img/blackhost-logo.svg" alt="Black Host" style="width:100%;max-width:200px">
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="https://www.v7n.com/">
|
|
<img alt="V7N" src="/img/v7n-logo.png" style="width:100%;max-width:200px">
|
|
</a>
|
|
</td>
|
|
<td>
|
|
<a href="https://bigsky.software"><img src="/img/bss.png" alt="Big Sky Software" style="width:100%;max-width:150px"></a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div style="text-align: center;font-style: italic;margin-top: 26px;">ʕ •ᴥ•ʔ made in montana</div>
|