nprasad2077/docs
1
1
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-09-20 04:58:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add htmx guidelines (#28993)

Browse Source 
To make sure we don't abuse it.

---------

Signed-off-by: Yarden Shoham <[email protected]>
Co-authored-by: wxiaoguang <[email protected]>
Co-authored-by: delvh <[email protected]>
This commit is contained in:
Yarden Shoham
2024-01-31 23:36:23 +01:00
committed by GitHub
co-authored by wxiaoguang delvh
parent b56c07f278
commit b244ceebfa
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
contributing/guidelines-frontend.en-us.md
+3
View File
@@ -65,14 +65,17 @@ Recommended implementations:
* Vue + Vanilla JS * Vue + Vanilla JS
* Fomantic-UI (jQuery) * Fomantic-UI (jQuery)
* htmx (partial page reloads for otherwise static components)
* Vanilla JS * Vanilla JS
Discouraged implementations: Discouraged implementations:
* Vue + Fomantic-UI (jQuery) * Vue + Fomantic-UI (jQuery)
* jQuery + Vanilla JS * 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. 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, Although mixing different frameworks is discouraged,
it should also work if the mixing is necessary and the code is well-designed and maintainable. it should also work if the mixing is necessary and the code is well-designed and maintainable.