localization

Documentation

Index

• Constants
• func LoadLocation(siteCode string) *time.Location
• func LocaleFromContext(ctx context.Context) string
• func Localize(lang string, msgID string, data interface{}) (string, error)
• func LocalizeMulti(lang string, msgIDs []string, data interface{}) (localizedMessages map[string]string, err error)
• func NewContextWithLocale(ctx context.Context, locale string) context.Context
• func RegisterLocale(locale string, localeDir string)
• func RegisterLocales(locales []string, localeDir string)
• type TextDirection
  • func TextDirectionFromLocale(locale string) TextDirection

Constants

const (
	TextDirectionLTR TextDirection = "LTR"
	TextDirectionRTL TextDirection = "RTL"

	LocaleArabic       = "ar"
	LocaleFarsiPersian = "fa"
	LocaleHebrew       = "he"
	LocaleKashmiri     = "ks"
	LocalePashto       = "ps"
	LocaleUrdu         = "ur"
	LocaleUyghur       = "ug"
	LocaleYiddish      = "yi"

	SiteCodeAlgeria               = "dz"
	SiteCodeAngola                = "ao"
	SiteCodeArgentina             = "ar"
	SiteCodeAustralian            = "au"
	SiteCodeBahrain               = "bh"
	SiteCodeBangladesh            = "bd"
	SiteCodeBotswana              = "bw"
	SiteCodeBrazil                = "br"
	SiteCodeCameroon              = "cm"
	SiteCodeCanada                = "ca"
	SiteCodeChile                 = "cl"
	SiteCodeChina                 = "cn"
	SiteCodeColumbia              = "co"
	SiteCodeCongo                 = "cd"
	SiteCodeEgypt                 = "eg"
	SiteCodeEthiopia              = "et"
	SiteCodeFrance                = "fr"
	SiteCodeGabon                 = "ga"
	SiteCodeGermany               = "de"
	SiteCodeGhana                 = "gh"
	SiteCodeGreatBritain          = "gb"
	SiteCodeHongKong              = "hk"
	SiteCodeIndia                 = "in"
	SiteCodeIndonesia             = "id"
	SiteCodeIran                  = "ir"
	SiteCodeIraq                  = "iq"
	SiteCodeIreland               = "ie"
	SiteCodeItaly                 = "it"
	SiteCodeIvoryCoast            = "ci"
	SiteCodeJapan                 = "jp"
	SiteCodeJordan                = "jo"
	SiteCodeKenya                 = "ke"
	SiteCodeKorea                 = "kr"
	SiteCodeKuwait                = "kw"
	SiteCodeLebanon               = "lb"
	SiteCodeLibya                 = "ly"
	SiteCodeMacau                 = "mo"
	SiteCodeMalaysia              = "my"
	SiteCodeMali                  = "ml"
	SiteCodeMauritius             = "mu"
	SiteCodeMexio                 = "mx"
	SiteCodeMorocco               = "ma"
	SiteCodeMozambique            = "mz"
	SiteCodeNamibia               = "na"
	SiteCodeNetherlands           = "nl"
	SiteCodeNewZealand            = "nz"
	SiteCodeNigeria               = "ng"
	SiteCodeOman                  = "om"
	SiteCodePakistan              = "pk"
	SiteCodePalestine             = "ps"
	SiteCodePhilippines           = "ph"
	SiteCodePoland                = "pl"
	SiteCodePortugal              = "pt"
	SiteCodeQatar                 = "qa"
	SiteCodeRussia                = "ru"
	SiteCodeRwanda                = "rw"
	SiteCodeSaudiArabia           = "sa"
	SiteCodeSenegal               = "sn"
	SiteCodeSingapore             = "sg"
	SiteCodeSouthAfrica           = "za"
	SiteCodeSpain                 = "es"
	SiteCodeSriLanka              = "lk"
	SiteCodeSudan                 = "sd"
	SiteCodeSweden                = "se"
	SiteCodeSwitzerland           = "ch"
	SiteCodeSyria                 = "sy"
	SiteCodeTaiwan                = "tw"
	SiteCodeTanzania              = "tz"
	SiteCodeThailand              = "th"
	SiteCodeTunisia               = "tn"
	SiteCodeTurkey                = "tr"
	SiteCodeUAE                   = "ae"
	SiteCodeUganda                = "ug"
	SiteCodeUnitedKingdom         = "uk"
	SiteCodeUnitedStatesOfAmerica = "us"
	SiteCodeVietnam               = "vn"
	SiteCodeZambia                = "zm"
	SiteCodeZimbabwe              = "zw"

	LocationAbidjian     = "Africa/Abidjan"
	LocationAccra        = "Africa/Accra"
	LocationAddisAbaba   = "Africa/Addis_Ababa"
	LocationAlgiers      = "Africa/Algiers"
	LocationAmman        = "Asia/Amman"
	LocationAmsterdam    = "Europe/Amsterdam"
	LocationAuckland     = "Pacific/Auckland"
	LocationBaghdad      = "Asia/Baghdad"
	LocationBahrain      = "Asia/Bahrain"
	LocationBamako       = "Africa/Bamako"
	LocationBangkok      = "Asia/Bangkok"
	LocationBeirut       = "Asia/Beirut"
	LocationBerlin       = "Europe/Berlin"
	LocationBogota       = "America/Bogota"
	LocationBuenosAires  = "America/Argentina/Buenos_Aires"
	LocationCairo        = "Africa/Cairo"
	LocationCasablanca   = "Africa/Casablanca"
	LocationColombo      = "Asia/Colombo"
	LocationDakar        = "Africa/Dakar"
	LocationDamascus     = "Asia/Damascus"
	LocationDaresSalaam  = "Africa/Dar_es_Salaam"
	LocationDhaka        = "Asia/Dhaka"
	LocationDouala       = "Africa/Douala"
	LocationDubai        = "Asia/Dubai"
	LocationDublin       = "Europe/Dublin"
	LocationGaborone     = "Africa/Gaborone"
	LocationHarare       = "Africa/Harare"
	LocationHebron       = "Asia/Hebron"
	LocationHoChiMinh    = "Asia/Ho_Chi_Minh"
	LocationHongKong     = "Asia/Hong_Kong"
	LocationIstanbul     = "Europe/Istanbul"
	LocationJakarta      = "Asia/Jakarta"
	LocationJohannesburg = "Africa/Johannesburg"
	LocationKampala      = "Africa/Kampala"
	LocationKarachi      = "Asia/Karachi"
	LocationKhartoum     = "Africa/Khartoum"
	LocationKigali       = "Africa/Kigali"
	LocationKinshasa     = "Africa/Kinshasa"
	LocationKolkata      = "Asia/Kolkata"
	LocationKualaLumpur  = "Asia/Kuala_Lumpur"
	LocationKuwait       = "Asia/Kuwait"
	LocationLagos        = "Africa/Lagos"
	LocationLibreville   = "Africa/Libreville"
	LocationLisbon       = "Europe/Lisbon"
	LocationLondon       = "Europe/London"
	LocationLosAngeles   = "America/Los_Angeles"
	LocationLuanda       = "Africa/Luanda"
	LocationLusaka       = "Africa/Lusaka"
	LocationMacau        = "Asia/Macau"
	LocationMadrid       = "Europe/Madrid"
	LocationManila       = "Asia/Manila"
	LocationMaputo       = "Africa/Maputo"
	LocationMauritius    = "Indian/Mauritius"
	LocationMexicoCity   = "America/Mexico_City"
	LocationMoscow       = "Europe/Moscow"
	LocationMuscat       = "Asia/Muscat"
	LocationNairobi      = "Africa/Nairobi"
	LocationParis        = "Europe/Paris"
	LocationQatar        = "Asia/Qatar"
	LocationRiyadh       = "Asia/Riyadh"
	LocationRome         = "Europe/Rome"
	LocationSantiago     = "America/Santiago"
	LocationSaoPaulo     = "America/Sao_Paulo"
	LocationSeoul        = "Asia/Seoul"
	LocationShanghai     = "Asia/Shanghai"
	LocationSingapore    = "Asia/Singapore"
	LocationStockholm    = "Europe/Stockholm"
	LocationSydney       = "Australia/Sydney"
	LocationTaipei       = "Asia/Taipei"
	LocationTehran       = "Asia/Tehran"
	LocationTokyo        = "Asia/Tokyo"
	LocationToronto      = "America/Toronto"
	LocationTripoli      = "Africa/Tripoli"
	LocationTunis        = "Africa/Tunis"
	LocationWarsaw       = "Europe/Warsaw"
	LocationWindhoek     = "Africa/Windhoek"
	LocationZurich       = "Europe/Zurich"
)

public constants

const (

	// DefaultLocale ...
	DefaultLocale string = "en"
)

Functions

func LoadLocation

func LoadLocation(siteCode string) *time.Location

LoadLocation loads location from siteCode, default to Asia/Dubai

func LocaleFromContext

func LocaleFromContext(ctx context.Context) string

LocaleFromContext tries to get locale from ctx, will return default locale if cannot

func Localize

func Localize(lang string, msgID string, data interface{}) (string, error)

Localize localizes a message & bind he data into message template

func LocalizeMulti

func LocalizeMulti(lang string, msgIDs []string, data interface{}) (localizedMessages map[string]string, err error)

LocalizeMulti localizes multiple messages & return a map from message ID to the localized message. It returns an error when any of the message ID cannot be localized.

func NewContextWithLocale

func NewContextWithLocale(ctx context.Context, locale string) context.Context

NewContextWithLocale returns a new context with input locale (or default locale if input is empty)

func RegisterLocale

func RegisterLocale(locale string, localeDir string)

RegisterLocale Locales

func RegisterLocales

func RegisterLocales(locales []string, localeDir string)

RegisterLocales Locales

Types

type TextDirection

type TextDirection string

TextDirection ...

func TextDirectionFromLocale

func TextDirectionFromLocale(locale string) TextDirection

TextDirectionFromLocale return text direction from locale