mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git

Patrick Kollitsch
13 hours ago 8269245c6edc93bd6ca9564cf0a12f93714d6a15
feat(i18n): show language labels in the language switcher

The switcher showed language keys such as `en` or `pt-br`. Show the
`label` of each language from the site configuration instead, and fall
back to the key when no label is set. Add `lang` and `hreflang` with
the language locale, so assistive technology reads each name in its
own language.

Closes #707

Signed-off-by: Patrick Kollitsch <davidsneighbourdev+gh@gmail.com>
1 files modified
5 files added
62 ■■■■■ changed files
layouts/_partials/i18nlist.html 4 ●●●●● patch | view | raw | blame | history
tests/fixtures/language-switcher/content/page.de.md 5 ●●●●● patch | view | raw | blame | history
tests/fixtures/language-switcher/content/page.en.md 5 ●●●●● patch | view | raw | blame | history
tests/fixtures/language-switcher/content/page.fr.md 5 ●●●●● patch | view | raw | blame | history
tests/fixtures/language-switcher/hugo.toml 17 ●●●●● patch | view | raw | blame | history
tests/fixtures/language-switcher/language-switcher.test.mjs 26 ●●●●● patch | view | raw | blame | history
layouts/_partials/i18nlist.html
@@ -3,7 +3,9 @@
<ul class="{{ compare.Conditional (compare.Eq $.Site.Language.Direction "rtl") "pr0 ml3" "pl0 mr3" }}">
    {{ range .Translations }}
    <li class="list f5 f4-ns fw4 dib {{ compare.Conditional (compare.Eq $.Site.Language.Direction "rtl") "pl3" "pr3" }}">
        <a class="hover-white white-90 no-underline" href="{{ .RelPermalink }}">{{ .Lang }}</a>
        {{- /* The link text is the language `label` from the site configuration,
               or the language key when no label is set (#707). */ -}}
        <a class="hover-white white-90 no-underline" href="{{ .RelPermalink }}" hreflang="{{ .Language.Locale }}" lang="{{ .Language.Locale }}">{{ .Language.Label | compare.Default .Lang }}</a>
    </li>
    {{ end}}
</ul>
tests/fixtures/language-switcher/content/page.de.md
New file
@@ -0,0 +1,5 @@
---
title: Seite
---
Deutsch.
tests/fixtures/language-switcher/content/page.en.md
New file
@@ -0,0 +1,5 @@
---
title: Page
---
English.
tests/fixtures/language-switcher/content/page.fr.md
New file
@@ -0,0 +1,5 @@
---
title: Page
---
Français.
tests/fixtures/language-switcher/hugo.toml
New file
@@ -0,0 +1,17 @@
title = "Language switcher fixture"
theme = "ananke"
defaultContentLanguage = "en"
[languages.en]
label = "English"
locale = "en-GB"
weight = 1
[languages.de]
label = "Deutsch"
locale = "de-DE"
weight = 2
[languages.fr]
locale = "fr-FR"
weight = 3
tests/fixtures/language-switcher/language-switcher.test.mjs
New file
@@ -0,0 +1,26 @@
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import { dirname, join } from "node:path";
import { test } from "node:test";
import { fileURLToPath } from "node:url";
import { load } from "cheerio";
import { buildFixtureSite } from "../../support/prepare-site.mjs";
const source = dirname(fileURLToPath(import.meta.url));
test("language switcher shows configured labels with language attributes (#707)", () => {
  const output = buildFixtureSite({ source });
  const $ = load(readFileSync(join(output, "page/index.html"), "utf8"));
  const links = $("header ul a[hreflang]")
    .map((_, el) => ({
      text: $(el).text().trim(),
      lang: $(el).attr("lang"),
      hreflang: $(el).attr("hreflang"),
      href: $(el).attr("href"),
    }))
    .get();
  assert.deepEqual(links, [
    { text: "Deutsch", lang: "de-DE", hreflang: "de-DE", href: "/de/page/" },
    { text: "fr", lang: "fr-FR", hreflang: "fr-FR", href: "/fr/page/" },
  ]);
});