mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-25 19:26:09 +01:00
Add document for webcomponents
(#23261)
This commit is contained in:
parent
ffce336f18
commit
0bfcbcc5e7
19
web_src/js/webcomponents/README.md
Normal file
19
web_src/js/webcomponents/README.md
Normal 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>`
|
Loading…
Reference in a new issue