Skip to content

Add htmx guidelines #28993

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

Merged
merged 5 commits into from
Jan 31, 2024
Merged

Add htmx guidelines #28993

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a2d7155
Add htmx guidelines
yardenshoham Jan 31, 2024
119c2d4
Update docs/content/contributing/guidelines-frontend.en-us.md
yardenshoham Jan 31, 2024
7935e3b
Clarify
yardenshoham Jan 31, 2024
148f67d
Update docs/content/contributing/guidelines-frontend.en-us.md
yardenshoham Jan 31, 2024
4a5ea52
Merge branch 'main' into htmx-guidelines
yardenshoham Jan 31, 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
3 changes: 3 additions & 0 deletions docs/content/contributing/guidelines-frontend.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,17 @@ Recommended implementations:

* Vue + Vanilla JS
* Fomantic-UI (jQuery)
* htmx (partial page reloads for otherwise static components)
* Vanilla JS

Discouraged implementations:

* Vue + Fomantic-UI (jQuery)
* jQuery + Vanilla JS
* htmx + any other framework which requires heavy JS code, or unnecessary features like htmx scripting (`hx-on`)

To make UI consistent, Vue components can use Fomantic-UI CSS classes.
We use htmx for simple interactions. You can see an example for simple interactions where htmx should be used in this [PR](https://github.com/go-gitea/gitea/pull/28908). Do not use htmx if you require more advanced reactivity, use another framework (Vue/Vanilla JS).
Although mixing different frameworks is discouraged,
it should also work if the mixing is necessary and the code is well-designed and maintainable.

Expand Down