]> source.dussan.org Git - gitea.git/commit
Introduce customized HTML elements, fix incorrect AppUrl usages in templates (#22861)
authorwxiaoguang <wxiaoguang@gmail.com>
Fri, 17 Feb 2023 14:02:20 +0000 (22:02 +0800)
committerGitHub <noreply@github.com>
Fri, 17 Feb 2023 14:02:20 +0000 (22:02 +0800)
commite7ef94e00f1319e5fb876f47fee28728bd671f07
tree7efb147ab55f5bda76e6e50cd0090cca5f0e5270
parentca445cf56628274ab5119816bf988f04204035a3
Introduce customized HTML elements, fix incorrect AppUrl usages in templates (#22861)

This PR follows:
* #21986
* #22831

This PR also introduce customized HTML elements, which would also help
problems like:
* #17760
* #21429
* #21440

With customized HTML elements, there won't be any load-search-replace
operations, and it can avoid page flicking (which @silverwind cares a
lot).

Browser support:
https://developer.mozilla.org/en-US/docs/Web/API/Window/customElements

# FAQ

## Why the component has the prefix?

As usual, I would strongly suggest to add prefixes for our own/private
names. The dedicated prefix will avoid conflicts in the future, and it
makes it easier to introduce various 3rd components, like GitHub's
`relative-time` component. If there is no prefix, it's impossible to
introduce another public component with the same name in the future.

## Why the `custcomp.js` is loaded before HTML body? The `index.js` is
after HTML body.

Customized components must be registered before the content loading.
Otherwise there would be still some flicking.

`custcomp.js` should have its own dependencies and should be very light,
so it won't affect the page loading time too much.

## Why use `data-url` attribute but not use the `textContent`?

According to the standard, the `connectedCallback` occurs on the
tag-opening moment. The element's children are not ready yet.

## Why not use `{{.GuessCurrentOrigin $.ctx ...}}` to let backend decide
the absolute URL?

It's difficult for backend to guess the correct protocol(scheme)
correctly with zero configuration. Generating the absolute URL from
frontend can guarantee that the URL is 100% correct -- since the user is
visiting it.

# Screenshot

<details>

![image](https://user-images.githubusercontent.com/2114189/218256757-a267c8ba-3108-4755-9ae5-329f1b08f615.png)

</details>
21 files changed:
templates/base/head_script.tmpl
templates/package/content/cargo.tmpl
templates/package/content/chef.tmpl
templates/package/content/composer.tmpl
templates/package/content/conan.tmpl
templates/package/content/conda.tmpl
templates/package/content/generic.tmpl
templates/package/content/helm.tmpl
templates/package/content/maven.tmpl
templates/package/content/npm.tmpl
templates/package/content/nuget.tmpl
templates/package/content/pub.tmpl
templates/package/content/pypi.tmpl
templates/package/content/rubygems.tmpl
templates/package/content/vagrant.tmpl
templates/post-install.tmpl
templates/repo/issue/view_content/pull_merge_instruction.tmpl
templates/repo/view_list.tmpl
templates/swagger/ui.tmpl
web_src/js/webcomponents/GiteaOriginUrl.js [new file with mode: 0644]
webpack.config.js