Fyne API "lang"
lang
import "fyne.io/fyne/v2/lang"
Package lang introduces a translation and localisation API for Fyne applications
Since 2.5
Usage
var (
// L is a shortcut to localize a string, similar to the gettext "_" function.
// More info available on the `Localize` function.
L = Localize
// N is a shortcut to localize a string with plural forms, similar to the ngettext function.
// More info available on the `LocalizePlural` function.
N = LocalizePlural
// X is a shortcut to get the localization of a string with specified key, similar to pgettext.
// More info available on the `LocalizeKey` function.
X = LocalizeKey
// XN is a shortcut to get the localization plural form of a string with specified key, similar to npgettext.
// More info available on the `LocalizePluralKey` function.
XN = LocalizePluralKey
)
func AddTranslations
func AddTranslations(r fyne.Resource) error
AddTranslations allows an app to load a bundle of translations. The language that this relates to will be inferred from the resource name, for example “fr.json”. The data should be in json format.
func AddTranslationsFS
func AddTranslationsFS(fs embed.FS, dir string) (retErr error)
AddTranslationsFS supports adding all translations in one calling using an embed.FS setup. The dir parameter specifies the name or path of the directory containing translation files inside this embedded filesystem. Each file should be a json file with the name following pattern [prefix.]lang.json.
func AddTranslationsForLocale
func AddTranslationsForLocale(data []byte, l fyne.Locale) error
AddTranslationsForLocale allows an app to load a bundle of translations for a specified locale. The data should be in json format.
func Localize
func Localize(in string, data ...any) string
Localize asks the translation engine to translate a string, this behaves like the gettext “_” function. The string can be templated and the template data can be passed as a struct with exported fields, or as a map of string keys to any suitable value.
func LocalizeKey
func LocalizeKey(key, fallback string, data ...any) string
LocalizeKey asks the translation engine for the translation with specific ID. If it cannot be found then the fallback will be used. The string can be templated and the template data can be passed as a struct with exported fields, or as a map of string keys to any suitable value.
func LocalizePlural
func LocalizePlural(in string, count int, data ...any) string
LocalizePlural asks the translation engine to translate a string from one of a number of plural forms. This behaves like the ngettext function, with the count parameter determining the plurality looked up. The string can be templated and the template data can be passed as a struct with exported fields, or as a map of string keys to any suitable value.
func LocalizePluralKey
func LocalizePluralKey(key, fallback string, count int, data ...any) string
LocalizePluralKey asks the translation engine for the translation with specific ID in plural form. This behaves like the npgettext function, with the count parameter determining the plurality looked up. If it cannot be found then the fallback will be used. The string can be templated and the template data can be passed as a struct with exported fields, or as a map of string keys to any suitable value.
func SystemLocale
func SystemLocale() fyne.Locale
SystemLocale returns the primary locale on the current system. This may refer to a language that Fyne does not have translations for.