2022-03-30 10:42:47 +02:00
|
|
|
{{if eq .PackageDescriptor.Package.Type "npm"}}
|
2022-06-27 22:58:46 +02:00
|
|
|
<h4 class="ui top attached header">{{.locale.Tr "packages.installation"}}</h4>
|
2022-03-30 10:42:47 +02:00
|
|
|
<div class="ui attached segment">
|
|
|
|
|
<div class="ui form">
|
|
|
|
|
<div class="field">
|
2022-06-27 22:58:46 +02:00
|
|
|
<label>{{svg "octicon-code"}} {{.locale.Tr "packages.npm.registry" | Safe}}</label>
|
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>
</details>
2023-02-17 15:02:20 +01:00
|
|
|
<div class="markup"><pre class="code-block"><code>{{if .PackageDescriptor.Metadata.Scope}}{{.PackageDescriptor.Metadata.Scope}}:{{end}}registry=<gitea-origin-url data-url="{{AppSubUrl}}/api/packages/{{.PackageDescriptor.Owner.Name}}/npm/"></gitea-origin-url></code></pre></div>
|
2022-03-30 10:42:47 +02:00
|
|
|
</div>
|
|
|
|
|
<div class="field">
|
2022-06-27 22:58:46 +02:00
|
|
|
<label>{{svg "octicon-terminal"}} {{.locale.Tr "packages.npm.install"}}</label>
|
2022-03-30 10:42:47 +02:00
|
|
|
<div class="markup"><pre class="code-block"><code>npm install {{.PackageDescriptor.Package.Name}}@{{.PackageDescriptor.Version.Version}}</code></pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="field">
|
2022-06-27 22:58:46 +02:00
|
|
|
<label>{{svg "octicon-code"}} {{.locale.Tr "packages.npm.install2"}}</label>
|
2022-03-30 10:42:47 +02:00
|
|
|
<div class="markup"><pre class="code-block"><code>"{{.PackageDescriptor.Package.Name}}": "{{.PackageDescriptor.Version.Version}}"</code></pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="field">
|
2022-06-27 22:58:46 +02:00
|
|
|
<label>{{.locale.Tr "packages.npm.documentation" | Safe}}</label>
|
2022-03-30 10:42:47 +02:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
{{if or .PackageDescriptor.Metadata.Description .PackageDescriptor.Metadata.Readme}}
|
2022-06-27 22:58:46 +02:00
|
|
|
<h4 class="ui top attached header">{{.locale.Tr "packages.about"}}</h4>
|
2022-03-30 10:42:47 +02:00
|
|
|
<div class="ui attached segment">
|
|
|
|
|
{{if .PackageDescriptor.Metadata.Readme}}
|
|
|
|
|
<div class="markup markdown">
|
2023-02-24 07:36:07 +01:00
|
|
|
{{RenderMarkdownToHtml $.Context .PackageDescriptor.Metadata.Readme}}
|
2022-03-30 10:42:47 +02:00
|
|
|
</div>
|
|
|
|
|
{{else if .PackageDescriptor.Metadata.Description}}
|
|
|
|
|
{{.PackageDescriptor.Metadata.Description}}
|
|
|
|
|
{{end}}
|
|
|
|
|
</div>
|
|
|
|
|
{{end}}
|
|
|
|
|
|
|
|
|
|
{{if or .PackageDescriptor.Metadata.Dependencies .PackageDescriptor.Metadata.DevelopmentDependencies .PackageDescriptor.Metadata.PeerDependencies .PackageDescriptor.Metadata.OptionalDependencies}}
|
2022-06-27 22:58:46 +02:00
|
|
|
<h4 class="ui top attached header">{{.locale.Tr "packages.dependencies"}}</h4>
|
2022-03-30 10:42:47 +02:00
|
|
|
<div class="ui attached segment">
|
|
|
|
|
<div class="ui list">
|
2022-06-27 22:58:46 +02:00
|
|
|
{{template "package/content/npm_dependencies" dict "root" $ "dependencies" .PackageDescriptor.Metadata.Dependencies "title" (.locale.Tr "packages.npm.dependencies")}}
|
|
|
|
|
{{template "package/content/npm_dependencies" dict "root" $ "dependencies" .PackageDescriptor.Metadata.DevelopmentDependencies "title" (.locale.Tr "packages.npm.dependencies.development")}}
|
|
|
|
|
{{template "package/content/npm_dependencies" dict "root" $ "dependencies" .PackageDescriptor.Metadata.PeerDependencies "title" (.locale.Tr "packages.npm.dependencies.peer")}}
|
|
|
|
|
{{template "package/content/npm_dependencies" dict "root" $ "dependencies" .PackageDescriptor.Metadata.OptionalDependencies "title" (.locale.Tr "packages.npm.dependencies.optional")}}
|
2022-03-30 10:42:47 +02:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
{{end}}
|
|
|
|
|
|
2022-04-19 18:55:35 +02:00
|
|
|
{{if .PackageDescriptor.Metadata.Keywords}}
|
2022-06-27 22:58:46 +02:00
|
|
|
<h4 class="ui top attached header">{{.locale.Tr "packages.keywords"}}</h4>
|
2022-03-30 10:42:47 +02:00
|
|
|
<div class="ui attached segment">
|
|
|
|
|
{{range .PackageDescriptor.Metadata.Keywords}}
|
|
|
|
|
{{.}}
|
|
|
|
|
{{end}}
|
|
|
|
|
</div>
|
|
|
|
|
{{end}}
|
|
|
|
|
{{end}}
|
