From 0bfcbcc5e769bd258e4f530e0f007f5465f42de5 Mon Sep 17 00:00:00 2001 From: wxiaoguang <wxiaoguang@gmail.com> Date: Fri, 3 Mar 2023 17:45:19 +0800 Subject: [PATCH] Add document for `webcomponents` (#23261) --- web_src/js/webcomponents/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 web_src/js/webcomponents/README.md diff --git a/web_src/js/webcomponents/README.md b/web_src/js/webcomponents/README.md new file mode 100644 index 0000000000..eabbc24ad1 --- /dev/null +++ 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>`