Add document for `webcomponents` (#23261)

2 years ago · 0bfcbcc5e7
parent ffce336f18
commit 0bfcbcc5e7
1 changed files with 19 additions and 0 deletions
--- a/web_src/js/webcomponents/README.md
+++ b/web_src/js/webcomponents/README.md
@ -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>`