Mirrors
/
gitea
mirror of https://github.com/go-gitea/gitea.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add document for `webcomponents` (#23261)

This commit is contained in:
wxiaoguang 2023-03-03 17:45:19 +08:00 committed by GitHub
parent ffce336f18
commit 0bfcbcc5e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
web_src/js/webcomponents/README.md Normal file
View File

@ -0,0 +1,19 @@
# Web Components
This `webcomponents` directory contains the source code for the web components used in the Gitea Web UI.
https://developer.mozilla.org/en-US/docs/Web/Web_Components
# Guidelines
* These components are loaded in `<head>` (before DOM body),
so they should have their own dependencies and should be very light,
then they won't affect the page loading time too much.
* If the component is not a public one, it's suggested to have its own `Gitea` or `gitea-` prefix to avoid conflicts.
# TODO
There are still some components that are not migrated to web components yet:
* `<span class="js-pretty-number">`
* `<time data-format>`