Language

The Language method on a Page object returns the Language object for the given page, derived from the language definition in your project configuration.

You can also use the Language method on a Site object. See details.

Methods

The examples below assume the following language definition.

languages:
  de:
    direction: ltr
    label: Deutsch
    locale: de-DE
    weight: 2

[languages]
  [languages.de]
    direction = 'ltr'
    label = 'Deutsch'
    locale = 'de-DE'
    weight = 2

{
   "languages": {
      "de": {
         "direction": "ltr",
         "label": "Deutsch",
         "locale": "de-DE",
         "weight": 2
      }
   }
}

Direction

(string) Returns the direction from the language definition.

{{ .Language.Direction }} → ltr

IsDefault

(bool) Reports whether this is the default language.

{{ .Language.IsDefault }} → true

Label

(string) Returns the label from the language definition.

{{ .Language.Label }} → Deutsch

Lang

Use Name instead.

LanguageCode

Use Locale instead.

LanguageDirection

Use Direction instead.

LanguageName

Use Label instead.

Locale

(string) Returns the locale from the language definition, falling back to Name.

{{ .Language.Locale }} → de-DE

Name

(string) Returns the language tag as defined by RFC 5646. This is the lowercased key from the language definition.

{{ .Language.Name }} → de

Weight

Example

Use the code below to create a language selector, allowing users to navigate between the different translated versions of the current page.

{{ with .Rotate "language" }}
  <nav class="language-selector">
    <ul>
      {{ range . }}
        {{ if eq .Language $.Language }}
          <li class="active">
            <a aria-current="page" href="{{ .Permalink }}" hreflang="{{ .Language.Locale }}">{{ .Language.Label }}</a>
          </li>
        {{ else }}
          <li>
            <a href="{{ .Permalink }}" hreflang="{{ .Language.Locale }}">{{ .Language.Label }}</a>
          </li>
        {{ end }}
      {{ end }}
    </ul>
  </nav>
{{ end }}