diff options
| author | Yarden Shoham <git@yardenshoham.com> | 2024-01-30 16:45:54 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-30 15:45:54 +0100 |
| commit | 3e8414179c3f3e8a12d3a66fdf32c144f941f5c3 (patch) | |
| tree | be2f951dd05c75badcc18540274bc553b210b1bb /web_src | |
| parent | 27d4c11ec3bd1658c07d0bb9b0b7f3712aafb0bb (diff) | |
| download | gitea-3e8414179c3f3e8a12d3a66fdf32c144f941f5c3.tar.gz gitea-3e8414179c3f3e8a12d3a66fdf32c144f941f5c3.zip | |
Introduce htmx and use it to avoid full page load on `Subscribe` and `Follow` (#28908)
- Closes https://github.com/go-gitea/gitea/issues/28880
This change introduces htmx with the hope we could use it to make Gitea
more reactive while keeping our "HTML rendered on the server" approach.
- Add `htmx.js` that imports `htmx.org` and initializes error toasts
- Place `hx-headers='{"x-csrf-token": "{{.CsrfToken}}"}'` on the
`<body>` tag so every request that htmx sends is authenticated
- Place `hx-swap="outerHTML"` on the `<body>` tag so the response of
each htmx request replaces the tag it targets (as opposed to its inner
content)
- Place `hx-push-url="false"` on the `<body>` tag so no changes to the
URL happen in `<form>` tags
- Add the `is-loading` class during request
### Error toasts in action
## Don't do a full page load when clicking the subscribe button
- Refactor the form around the subscribe button into its own template
- Use htmx to perform the form submission
- `hx-boost="true"` to prevent the default form submission behavior of a
full page load
- `hx-sync="this:replace"` to replace the current request (in case the
button is clicked again before the response is returned)
- `hx-target="this"` to replace the form tag with the new form tag
- Change the backend response to return a `<form>` tag instead of a
redirect to the issue page
### Before
### After
## Don't do a full page load when clicking the follow button
- Use htmx to perform the button request
- `hx-post="{{.ContextUser.HomeLink}}?action=follow"` to send a POST
request to follow the user
- `hx-target="#profile-avatar-card"` to target the card div for
replacement
- `hx-indicator="#profile-avatar-card"` to place the loading indicator
on the card
- Change the backend response to return a `<div>` tag (the card) instead
of a redirect to the user page
### Before
### After
---------
Signed-off-by: Yarden Shoham <git@yardenshoham.com>
Co-authored-by: 6543 <m.huber@kithara.com>
Co-authored-by: Giteabot <teabot@gitea.io>
Diffstat (limited to 'web_src')
| -rw-r--r-- | web_src/js/features/common-global.js | 1 | ||||
| -rw-r--r-- | web_src/js/htmx.js | 18 |
2 files changed, 19 insertions, 0 deletions
diff --git a/web_src/js/features/common-global.js b/web_src/js/features/common-global.js index 0b00eb8e8e..e8b546970f 100644 --- a/web_src/js/features/common-global.js +++ b/web_src/js/features/common-global.js @@ -12,6 +12,7 @@ import {showTemporaryTooltip} from '../modules/tippy.js'; import {confirmModal} from './comp/ConfirmModal.js'; import {showErrorToast} from '../modules/toast.js'; import {request, POST} from '../modules/fetch.js'; +import '../htmx.js'; const {appUrl, appSubUrl, csrfToken, i18n} = window.config; diff --git a/web_src/js/htmx.js b/web_src/js/htmx.js new file mode 100644 index 0000000000..92400d1cbe --- /dev/null +++ b/web_src/js/htmx.js @@ -0,0 +1,18 @@ +import * as htmx from 'htmx.org'; +import {showErrorToast} from './modules/toast.js'; + +// https://htmx.org/reference/#config +htmx.config.requestClass = 'is-loading'; +htmx.config.scrollIntoViewOnBoost = false; + +// https://htmx.org/events/#htmx:sendError +document.body.addEventListener('htmx:sendError', (event) => { + // TODO: add translations + showErrorToast(`Network error when calling ${event.detail.requestConfig.path}`); +}); + +// https://htmx.org/events/#htmx:responseError +document.body.addEventListener('htmx:responseError', (event) => { + // TODO: add translations + showErrorToast(`Error ${event.detail.xhr.status} when calling ${event.detail.requestConfig.path}`); +}); |