Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update preload extension documentation: form preloading and preload="always" #3001

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update preload extension documentation: form preloading and preload="always" #3001

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a37032
Update documentation for preload extension - include form element pre…
marisst Nov 5, 2024
804e93c
Adjust version number
marisst Nov 6, 2024
7a08580
Document HX-Preload header
marisst Nov 11, 2024
9e8b2db
Rename preloaded header from HX-Preload to HX-Preloaded
marisst Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion www/content/extensions/preload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ unused requests. Use this extension carefully!
## Install

```html
<script src="https://unpkg.com/[email protected].1/preload.js"></script>
<script src="https://unpkg.com/[email protected].3/preload.js"></script>
```

## Usage
Expand All @@ -35,6 +35,8 @@ giving your application a roughly 100-200ms head start on serving responses. See
</body>
```

All preload requests include an additional `"HX-Preloaded": "true"` header.

### Inheriting Preload Settings

You can add the `preload` attribute to the top-level element that contains several `<a href="">` or `hx-get=""`
Expand All @@ -52,6 +54,15 @@ you preload many more resources than you need.
</body>
```

### Preloading Forms

The extension can preload some form elements if the form includes `hx-get` attribute or uses `method="get"`. The `preload` attribute can be added to the form or to some of its selected elements. Currently these form elements can be preloaded:
- `<input type="radio>">` will be preloaded as if the radio button was clicked and form submitted
- `<input type="checkbox">` will be preloaded as if the checkbox was checked and form submitted
- `<input type="checkbox" checked>` will be preloaded as if the checkbox was unchecked and form submitted
- `<select>` will send multiple preload requests as if each unselected option was selected and form submitted
- `<input type="submit">` will be preloaded as if form was submitted

### Preloading of Linked Images

After an HTML page (or page fragment) is preloaded, this extension can also preload linked image resources. It will not
Expand Down Expand Up @@ -115,6 +126,13 @@ trigger preloads as soon as an object has been processed by htmx.
</body>
```

#### preload="always"

By default, the extension will preload each element once.
If you would like to keep always preloading the element, you can add `preload="always"` attribute.
This can be useful if `hx-target` is not the element itself.
This attribute can be conbined with other configuration attributes e.g. `preload="always mouseover"`.

### About Touch Events

To accommodate touchscreen devices, an additional `ontouchstart` event handler is added whenever you specify
Expand Down