lang

Documentation

Overview

Package lang provides template functions for content internationalization.

Index

• type Namespace
  • func New(deps *deps.Deps, translator locales.Translator) *Namespace
  • func (ns *Namespace) FormatAccounting(precision, currency, number any) (string, error)
  • func (ns *Namespace) FormatCurrency(precision, currency, number any) (string, error)
  • func (ns *Namespace) FormatNumber(precision, number any) (string, error)
  • func (ns *Namespace) FormatNumberCustom(precision, number any, options ...any) (string, error)
  • func (ns *Namespace) FormatPercent(precision, number any) (string, error)
  • func (ns *Namespace) Merge(p2, p1 any) (any, error)
  • func (ns *Namespace) NumFmt(precision, number any, options ...any) (string, error)
  • func (ns *Namespace) Translate(id any, args ...any) (string, error)

Types

type Namespace

type Namespace struct {
	// contains filtered or unexported fields
}

Namespace provides template functions for the "lang" namespace.

func New

func New(deps *deps.Deps, translator locales.Translator) *Namespace

New returns a new instance of the lang-namespaced template functions.

func (*Namespace) FormatAccounting

func (ns *Namespace) FormatAccounting(precision, currency, number any) (string, error)

FormatAccounting returns the currency representation of number for the given currency and precision for the current language in accounting notation.

The return value is formatted with at least two decimal places.

func (*Namespace) FormatCurrency

func (ns *Namespace) FormatCurrency(precision, currency, number any) (string, error)

FormatCurrency returns the currency representation of number for the given currency and precision for the current language.

The return value is formatted with at least two decimal places.

func (*Namespace) FormatNumber

func (ns *Namespace) FormatNumber(precision, number any) (string, error)

FormatNumber formats number with the given precision for the current language.

func (*Namespace) FormatNumberCustom

func (ns *Namespace) FormatNumberCustom(precision, number any, options ...any) (string, error)

FormatNumberCustom formats a number with the given precision using the negative, decimal, and grouping options. The `options` parameter is a string consisting of `<negative> <decimal> <grouping>`. The default `options` value is `- . ,`.

Note that numbers are rounded up at 5 or greater. So, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.

For a simpler function that adapts to the current language, see FormatNumber.

func (*Namespace) FormatPercent

func (ns *Namespace) FormatPercent(precision, number any) (string, error)

FormatPercent formats number with the given precision for the current language. Note that the number is assumed to be a percentage.

func (*Namespace) Merge

func (ns *Namespace) Merge(p2, p1 any) (any, error)

Merge creates a union of pages from two languages.

func (*Namespace) NumFmt

func (ns *Namespace) NumFmt(precision, number any, options ...any) (string, error)

NumFmt is deprecated, use FormatNumberCustom. We renamed this in Hugo 0.87. Deprecated: Use FormatNumberCustom

func (*Namespace) Translate

func (ns *Namespace) Translate(id any, args ...any) (string, error)

Translate returns a translated string for id.