Skip to content

feat: add translation status display switcher #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 6, 2025
Merged

feat: add translation status display switcher #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9b69e1
feat: add translation status display property to metadata
3w36zj6 Sep 6, 2025
bd43cfe
feat: add logic to control translation status display
3w36zj6 Sep 6, 2025
a80b895
feat: add logic to control translation coverage badge display
3w36zj6 Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions website/src/components/templates/BaseTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { html } from "hono/html";
import type { FC, PropsWithChildren } from "hono/jsx";
import { basePath, originUrl, typstOfficialDocsUrl } from "../../metadata";
import {
basePath,
displayTranslationStatus,
originUrl,
typstOfficialDocsUrl,
} from "../../metadata";
import { Translation, translation } from "../../translation/";
import type { Page } from "../../types/model";
import { joinPath, shiftBase } from "../../utils/path";
Expand Down Expand Up @@ -208,7 +213,10 @@ export const BaseTemplate: FC<BaseTemplateProps> = ({
<Breadcrumbs path={path} />

<div class="flex flex-col gap-2 my-4">
<TranslationStatusAlert status={translationStatus} />
{(displayTranslationStatus ||
translationStatus === "community") && (
<TranslationStatusAlert status={translationStatus} />
)}
</div>

{translationStatus !== "community" && (
Expand Down
11 changes: 7 additions & 4 deletions website/src/components/ui/common/Header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {
discordServerUrl,
displayTranslationStatus,
githubRepositoryUrl,
typstOfficialDocsUrl,
typstOfficialUrl,
Expand Down Expand Up @@ -57,7 +58,7 @@ export const Header = () => {
<div class="flex items-center gap-2 flex-shrink-0">
<SiteTitle />
<VersionBadge />
<TranslationCoverageBadge />
{displayTranslationStatus && <TranslationCoverageBadge />}
</div>

<div class="xl:absolute xl:left-1/2 xl:transform xl:-translate-x-1/2">
Expand Down Expand Up @@ -128,9 +129,11 @@ export const Header = () => {
<SiteTitle />
<VersionBadge />
</div>
<div>
<TranslationCoverageBadge />
</div>
{displayTranslationStatus && (
<div>
<TranslationCoverageBadge />
</div>
)}
</div>
<div class="flex items-center gap-2 flex-shrink-0 self-center">
<button
Expand Down
2 changes: 2 additions & 0 deletions website/src/metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ export const discordServerUrl = "https://discord.gg/9xF7k4aAuH";
export const originUrl = "https://typst-jp.github.io/";
/** The base public path for deployment. This must match the value used in typst-docs. */
export const basePath: "/" | `/${string}/` = "/docs/";
/** Indicates whether to display the translation status on the site. Community content is always displayed. */
export const displayTranslationStatus: boolean = true;