l10n

Documentation

Index

• Constants
• Variables
• func IsLocalizable(obj interface{}) (isLocalizable bool)
• func IsLocalizableFromContext(ctx context.Context) (localeCode string, isLocalizable bool)
• func LocalePathFromContext(m interface{}, ctx context.Context) (localePath string)
• func MustGetTranslation(r *http.Request, key string) string
• type Builder
  • func New(db *gorm.DB) *Builder
  • func (b *Builder) Activity(v *activity.Builder) (r *Builder)
  • func (b *Builder) ContextValueProvider(in context.Context) context.Context
  • func (b *Builder) EnsureLocale(in http.Handler) (out http.Handler)
  • func (b *Builder) GetAllLocalePaths() (r []string)
  • func (b *Builder) GetCookieName() string
  • func (b *Builder) GetCorrectLocaleCode(r *http.Request) string
  • func (b *Builder) GetCurrentLocaleCodeFromCookie(r *http.Request) (localeCode string)
  • func (b *Builder) GetLocaleImg(localeCode string) string
  • func (b *Builder) GetLocaleLabel(localeCode string) string
  • func (b *Builder) GetLocalePath(localeCode string) string
  • func (b *Builder) GetQueryName() string
  • func (b *Builder) GetSupportLocaleCodes() (r []string)
  • func (b *Builder) GetSupportLocaleCodesFromRequest(R *http.Request) []string
  • func (b *Builder) Install(pb *presets.Builder) error
  • func (b *Builder) IsTurnedOn() bool
  • func (b *Builder) ModelInstall(pb *presets.Builder, m *presets.ModelBuilder) error
  • func (b *Builder) RegisterLocales(localeCode, localePath, localeLabel, img string) (r *Builder)
  • func (b *Builder) SupportLocalesFunc(v func(R *http.Request) []string) (r *Builder)
• type Locale
  • func EmbedLocale(v any) *Locale
  • func (l *Locale) EmbedLocale() *Locale
• type LocaleInterface
• type Messages
• type SelectLocale

Constants

const (
	WrapHandlerKey  = "l10nWrapHandlerKey"
	MenuTopItemFunc = "l10nMenuTopItemFunc"
	SlugLocaleCode  = "locale_code"
)

const (
	Localize   = "l10n_LocalizeEvent"
	DoLocalize = "l10n_DoLocalizeEvent"

	FromID      = "l10n_DoLocalize_FromID"
	FromVersion = "l10n_DoLocalize_FromVersion"
	FromLocale  = "l10n_DoLocalize_FromLocale"

	LocalizeFrom = "Localize From"
	LocalizeTo   = "Localize To"
)

const (
	InternationalSvg = `` /* 4392-byte string literal not displayed */

	ChinaSvg = `` /* 1039-byte string literal not displayed */

	JapanSvg = `` /* 473-byte string literal not displayed */

)

const I18nLocalizeKey i18n.ModuleKey = "I18nLocalizeKey"

const LocaleCode l10nContextKey = iota

Variables

var IncorrectLocaleErr = errors.New("incorrect locale")

var Messages_en_US = &Messages{
	Localize:              "Localize",
	LocalizeFrom:          "From",
	LocalizeTo:            "To",
	SuccessfullyLocalized: "Successfully Localized",
	Location:              "Location",
	Colon:                 ":",
	International:         "International",
	China:                 "China",
	Japan:                 "Japan",
}

var Messages_ja_JP = &Messages{
	Localize:              "ローカライズ",
	LocalizeFrom:          "から",
	LocalizeTo:            "に",
	SuccessfullyLocalized: "ローカライズに成功しました",
	Location:              "場所",
	Colon:                 ":",
	International:         "国際的",
	China:                 "中国",
	Japan:                 "日本",
}

var Messages_zh_CN = &Messages{
	Localize:              "本地化",
	LocalizeFrom:          "从",
	LocalizeTo:            "到",
	SuccessfullyLocalized: "本地化成功",
	Location:              "地区",
	Colon:                 "：",
	International:         "全球",
	China:                 "中国",
	Japan:                 "日本",
}

Functions

func IsLocalizable

func IsLocalizable(obj interface{}) (isLocalizable bool)

func IsLocalizableFromContext

func IsLocalizableFromContext(ctx context.Context) (localeCode string, isLocalizable bool)

func LocalePathFromContext

func LocalePathFromContext(m interface{}, ctx context.Context) (localePath string)

func MustGetTranslation

func MustGetTranslation(r *http.Request, key string) string

Types

type Builder

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

func New

func New(db *gorm.DB) *Builder

func (*Builder) Activity

func (b *Builder) Activity(v *activity.Builder) (r *Builder)

func (*Builder) ContextValueProvider

func (b *Builder) ContextValueProvider(in context.Context) context.Context

func (*Builder) EnsureLocale

func (b *Builder) EnsureLocale(in http.Handler) (out http.Handler)

func (*Builder) GetAllLocalePaths

func (b *Builder) GetAllLocalePaths() (r []string)

func (*Builder) GetCookieName

func (b *Builder) GetCookieName() string

func (*Builder) GetCorrectLocaleCode

func (b *Builder) GetCorrectLocaleCode(r *http.Request) string

func (*Builder) GetCurrentLocaleCodeFromCookie

func (b *Builder) GetCurrentLocaleCodeFromCookie(r *http.Request) (localeCode string)

func (*Builder) GetLocaleImg

func (b *Builder) GetLocaleImg(localeCode string) string

func (*Builder) GetLocaleLabel

func (b *Builder) GetLocaleLabel(localeCode string) string

func (*Builder) GetLocalePath

func (b *Builder) GetLocalePath(localeCode string) string

func (*Builder) GetQueryName

func (b *Builder) GetQueryName() string

func (*Builder) GetSupportLocaleCodes

func (b *Builder) GetSupportLocaleCodes() (r []string)

func (*Builder) GetSupportLocaleCodesFromRequest

func (b *Builder) GetSupportLocaleCodesFromRequest(R *http.Request) []string

func (*Builder) Install

func (b *Builder) Install(pb *presets.Builder) error

func (*Builder) IsTurnedOn

func (b *Builder) IsTurnedOn() bool

func (*Builder) ModelInstall

func (b *Builder) ModelInstall(pb *presets.Builder, m *presets.ModelBuilder) error

func (*Builder) RegisterLocales

func (b *Builder) RegisterLocales(localeCode, localePath, localeLabel, img string) (r *Builder)

func (*Builder) SupportLocalesFunc

func (b *Builder) SupportLocalesFunc(v func(R *http.Request) []string) (r *Builder)

type Locale

type Locale struct {
	LocaleCode string `sql:"size:20" gorm:"primaryKey;default:''"`
}

Locale embed this struct into GROM-backend models to enable localization feature for your model

func EmbedLocale

func EmbedLocale(v any) *Locale

func (*Locale) EmbedLocale

func (l *Locale) EmbedLocale() *Locale

GetLocale get model's locale

type LocaleInterface

type LocaleInterface interface {
	EmbedLocale() *Locale
}

type Messages

type Messages struct {
	Localize              string
	LocalizeFrom          string
	LocalizeTo            string
	SuccessfullyLocalized string
	Location              string
	Colon                 string
	International         string
	China                 string
	Japan                 string
}

type SelectLocale

type SelectLocale struct {
	// label is a descriptive name used to display the name of a language or region to the user.
	// It is usually a user-friendly string, such as "English", "French", "Chinese", etc. In the user interface,
	// it is used to display selectable localization options.
	Label string

	// code is an identifier that represents a language or locale.
	// It is usually a string that represents a specific language or region code, such as "en" (English), "fr" (French), "zh" (Chinese), etc. In code,
	// it is used to distinguish between different localized versions.
	Code string
}