mirror of
https://github.com/bigskysoftware/htmx.git
synced 2026-01-20 07:36:12 +00:00
25c2a08617
flatten website directory structure and redesign UI - move all templates from themes/htmx-theme/templates/ to www/templates/ - move all static assets from themes/htmx-theme/static/ to www/static/ - remove theme layer and update config.toml - add tailwind css with typography plugin - update hero section with 3D effects and subtle synthwave aesthetic - update header with improved design and navigation - add shortcut for search bar in header (CMD+K on macos, CTRL+K elsewhere) - add status bar in header that displays title=... attribute on hover for any element - update footer with improved design and navigation - rename "examples" to "patterns" throughout site and docs - reorganize patterns page from 7 categories to 4 (loading, interaction, display, advanced) - add mac os9 finder-style design to patterns page with Chicago FLF font (classic OS9 window title font) - add sidebar table of contents for /docs/, /reference/, and /htmx-4/ pages (mobile version still TODO) - add `npm run site` script that uses npx for tailwindcss and zola-bin (no external dependencies needed) - remove github buttons.js dependency and replace with custom buttons - consolidate sponsor images into www/static/img/sponsors/ with logo-<company>.png|svg format - standardize all image filenames to lowercase kebab-case - clean up unused sponsor images from www/static/img/ - create construction_warning() shortcode for work-in-progress sections - add reusable template components (toc, anchor links, sponsors shortcode) - add horse easter egg when URL includes ?horse=true - update website htmx.js to latest version - update npm dependencie
107 lines
3.7 KiB
Markdown
107 lines
3.7 KiB
Markdown
[](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/extensions/ws/) and [Server Sent Events](https://htmx.org/extensions/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://cdn.jsdelivr.net/npm/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://cdn.jsdelivr.net/npm/htmx.org@2.0.8/dist/htmx.min.js"></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](dev/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.
|
|
|
|
## haiku
|
|
|
|
*javascript fatigue:<br/>
|
|
longing for a hypertext<br/>
|
|
already in hand*
|