i18nui

package
v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 20, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package i18nui provides translated default strings for framework UI surfaces. When a translator is configured (via App.WithI18n), these defaults are resolved through the translator. Without a translator, English fallbacks are returned.

This addresses the i18n surface coverage gap: entity field labels, validator error messages, and framework/ui defaults (Pagination, ValidationSummary, EmptyState, Banner, Toast) currently emit hardcoded English.

Index

Constants

This section is empty.

Variables

View Source 
var Defaults = map[Key]string{}/* 122 elements not displayed */

Defaults are the English fallback strings. Apps that provide their own translations should cover all of these keys.

Functions

func LabelForField 

func LabelForField(ctx context.Context, tr *i18n.Translator, entityName, fieldName string) string

LabelForField returns the display label for an entity field. If a translation key "entity.<entity>.field.<field>" exists in the translator's catalog for the ctx locale, it's used. Otherwise the field name is humanized.

func T 

func T(ctx context.Context, key Key) string

T translates a key. If ctx carries a translator (via WithTranslator), it is consulted first; otherwise the English default for the key is returned, or the bare key string when no default exists (so missing keys surface visibly rather than as empty strings).

Callers without a ctx in scope can pass context.Background() — the English defaults still apply.

func TVars added in v0.19.0 

func TVars(ctx context.Context, key Key, vars map[string]string) string

TVars translates a key and interpolates {name} placeholders from vars. Interpolation applies to whichever string wins the lookup (translator hit or English default), so the same {name} tokens work in app catalogs and in the built-in defaults. Unknown placeholders are left as-is (matching TranslateValidation). A translator miss falls through to Defaults — the same miss-fallback as T.

Example: i18nui.TVars(ctx, i18nui.KeyTableSortBy, map[string]string{"column": "name"}) → "Sort by name" (or the catalog's "ui.table.sortBy" for the locale).

func TranslateValidation 

func TranslateValidation(ctx context.Context, tr *i18n.Translator, validator string, vars map[string]string) string

TranslateValidation returns a translated validation error message for the given validator type, with optional template variables. ctx carries the per-request locale; tr may be nil to use English defaults.

Renamed from ValidationError so the symbol no longer collides with core/handler.ValidationError when a file imports both packages.

func WithTranslator 

func WithTranslator(ctx context.Context, tr *i18n.Translator) context.Context

WithTranslator attaches a translator to ctx so callers downstream can resolve translations via T(ctx, key) without threading a translator argument through every signature.

Types

type Key 

type Key string

Key is a translation key for framework UI surfaces. 

const (
	// Pagination
	KeyPaginationPrevious Key = "ui.pagination.previous"
	KeyPaginationNext     Key = "ui.pagination.next"
	KeyPaginationPage     Key = "ui.pagination.page"
	KeyPaginationOf       Key = "ui.pagination.of"
	KeyPaginationShowing  Key = "ui.pagination.showing"
	KeyPaginationResults  Key = "ui.pagination.results"
	KeyPaginationLabel    Key = "ui.pagination.label"

	// Validation
	KeyValidationRequired Key = "ui.validation.required"
	KeyValidationEmail    Key = "ui.validation.email"
	KeyValidationMin      Key = "ui.validation.min"
	KeyValidationMax      Key = "ui.validation.max"
	KeyValidationMinLen   Key = "ui.validation.minLength"
	KeyValidationMaxLen   Key = "ui.validation.maxLength"
	KeyValidationPattern  Key = "ui.validation.pattern"
	KeyValidationUnique   Key = "ui.validation.unique"

	// Empty state
	KeyEmptyStateTitle Key = "ui.empty.title"
	KeyEmptyStateDesc  Key = "ui.empty.description"

	// Dialog / modal
	KeyDialogConfirm Key = "ui.dialog.confirm"
	KeyDialogCancel  Key = "ui.dialog.cancel"
	KeyDialogClose   Key = "ui.dialog.close"
	KeyDialogSave    Key = "ui.dialog.save"
	KeyDialogDelete  Key = "ui.dialog.delete"

	// Toast
	KeyToastSuccess Key = "ui.toast.success"
	KeyToastError   Key = "ui.toast.error"
	KeyToastWarning Key = "ui.toast.warning"
	KeyToastInfo    Key = "ui.toast.info"

	// Banner
	KeyBannerDismiss Key = "ui.banner.dismiss"

	// DataTable
	KeyTableSortAsc   Key = "ui.table.sortAscending"
	KeyTableSortDesc  Key = "ui.table.sortDescending"
	KeyTableNoSort    Key = "ui.table.noSort"
	KeyTableFilter    Key = "ui.table.filter"
	KeyTableNoResults Key = "ui.table.noResults"
	KeyTableLoading   Key = "ui.table.loading"

	// File upload
	KeyFileUploadDrop   Key = "ui.fileUpload.dropzone"
	KeyFileUploadBrowse Key = "ui.fileUpload.browse"
	KeyFileUploadRemove Key = "ui.fileUpload.remove"

	// Form
	KeyFormSubmit  Key = "ui.form.submit"
	KeyFormReset   Key = "ui.form.reset"
	KeyFormSending Key = "ui.form.sending"
	KeyFormSuccess Key = "ui.form.success"
	KeyFormError   Key = "ui.form.error"
	KeyFormYes     Key = "ui.form.yes"
	KeyFormNo      Key = "ui.form.no"

	// Search
	KeySearchPlaceholder Key = "ui.search.placeholder"
	KeySearchNoResults   Key = "ui.search.noResults"

	// Auth
	KeyAuthLogin      Key = "ui.auth.login"
	KeyAuthLogout     Key = "ui.auth.logout"
	KeyAuthSignup     Key = "ui.auth.signup"
	KeyAuthEmail      Key = "ui.auth.email"
	KeyAuthPassword   Key = "ui.auth.password"
	KeyAuthRememberMe Key = "ui.auth.rememberMe"

	// Repeater
	KeyRepeaterAdd    Key = "ui.repeater.add"
	KeyRepeaterRemove Key = "ui.repeater.remove"

	// PasswordInput
	KeyPasswordInputShow Key = "ui.passwordInput.show"
	KeyPasswordInputHide Key = "ui.passwordInput.hide"

	// Lightbox
	KeyLightboxPrev     Key = "ui.lightbox.previous"
	KeyLightboxNext     Key = "ui.lightbox.next"
	KeyLightboxDownload Key = "ui.lightbox.download"

	// StepWizard
	KeyStepWizardBack   Key = "ui.stepWizard.back"
	KeyStepWizardNext   Key = "ui.stepWizard.next"
	KeyStepWizardSubmit Key = "ui.stepWizard.submit"
	// DataTable extras
	KeyTableEmptyDesc Key = "ui.table.emptyDescription"
	KeyTableSortBy    Key = "ui.table.sortBy"

	// FilterToolbar
	KeyFilterToolbarLabel Key = "ui.filterToolbar.label"
	KeyFilterApply        Key = "ui.filterToolbar.apply"
	KeyFilterReset        Key = "ui.filterToolbar.reset"
	KeyFilterAll          Key = "ui.filterToolbar.all" // "All {label}"
	KeyFilterAllPlain     Key = "ui.filterToolbar.allPlain"
	KeyFilterSortBy       Key = "ui.filterToolbar.sortBy"
	// FilterChipBar
	KeyFilterClearAll   Key = "ui.filterChipBar.clearAll"
	KeyFilterChipRemove Key = "ui.filterChipBar.removeFilter" // "Remove filter {label}"

	// Search extras
	KeySearchInputPlaceholder Key = "ui.search.inputPlaceholder" // "Search..." (ASCII dots)
	KeySearchLabel            Key = "ui.search.label"
	KeySearchClear            Key = "ui.search.clear"

	// CommandPalette
	KeyCommandPalettePlaceholder Key = "ui.commandPalette.placeholder"
	KeyCommandPaletteOpen        Key = "ui.commandPalette.open"
	KeyCommandPaletteTitle       Key = "ui.commandPalette.title"
	KeyCommandPaletteNavigate    Key = "ui.commandPalette.navigate"
	KeyCommandPaletteSelect      Key = "ui.commandPalette.select"
	KeyCommandPaletteClose       Key = "ui.commandPalette.close"

	// Form extras
	KeyFormErrorsSummary      Key = "ui.form.errorsSummary"
	KeyFormHasErrors          Key = "ui.form.hasErrors"
	KeyFormSave               Key = "ui.form.save"
	KeyValidationSummaryTitle Key = "ui.validationSummary.title"

	// Carousel
	KeyCarouselPrevious   Key = "ui.carousel.previous"
	KeyCarouselNext       Key = "ui.carousel.next"
	KeyCarouselGoTo       Key = "ui.carousel.goTo" // "Go to slide {slide}"
	KeyCarouselPagination Key = "ui.carousel.pagination"

	// Counter
	KeyCounterDecrement Key = "ui.counter.decrement"
	KeyCounterIncrement Key = "ui.counter.increment"
	KeyCounterLabel     Key = "ui.counter.label"

	// NumberInput
	KeyNumberDecrement Key = "ui.number.decrement" // "Decrement {label}"
	KeyNumberIncrement Key = "ui.number.increment" // "Increment {label}"

	// Spinner / common
	KeyLoading Key = "ui.loading"

	// Sparkline
	KeySparklineNoData Key = "ui.sparkline.noData"

	// Auth extras
	KeySignOut Key = "ui.auth.signOut"

	// FileDropzone
	KeyDropzoneDropFiles     Key = "ui.dropzone.promptMultiple"
	KeyDropzoneDropFile      Key = "ui.dropzone.promptSingle"
	KeyDropzoneMaxSize       Key = "ui.dropzone.maxSize"       // "Max {n} MB."
	KeyDropzoneMaxSizeSuffix Key = "ui.dropzone.maxSizeSuffix" // " (max {n} MB)"

	// FileUpload extras
	KeyFileUploadDropSingle Key = "ui.fileUpload.dropzoneSingle" // "Drop a file here, or click to browse"
	KeyFileMaxSize          Key = "ui.fileUpload.maxSize"        // "Max {n} MB"

	// Notification
	KeyNotificationDismiss Key = "ui.notification.dismiss"
	KeyNotificationEmpty   Key = "ui.notification.empty"

	// PollingIndicator
	KeyPollingLive Key = "ui.polling.live"

	// CopyButton
	KeyCopyCopy        Key = "ui.copy.copy"
	KeyCopyCopied      Key = "ui.copy.copied"
	KeyCopyToClipboard Key = "ui.copy.toClipboard"

	// ProgressSteps
	KeyProgressLabel Key = "ui.progress.label"

	// Tag
	KeyTagRemove Key = "ui.tag.remove" // "Remove {label}"

	// StepWizard extras
	KeyStepWizardStep   Key = "ui.stepWizard.step"   // "Step {step}: {heading}"
	KeyStepWizardStepOf Key = "ui.stepWizard.stepOf" // "Step {step} of {total}"

	// Section
	KeySectionLabel Key = "ui.section.label"

	// ThemeToggle
	KeyThemeToggle      Key = "ui.themeToggle.toggle"
	KeyThemeLight       Key = "ui.themeToggle.light"
	KeyThemeDark        Key = "ui.themeToggle.dark"
	KeyThemeAuto        Key = "ui.themeToggle.auto"
	KeyThemeColorScheme Key = "ui.themeToggle.colorScheme"

	// SiteHeader nav
	KeyNavPrimary       Key = "ui.nav.primary"
	KeyNavMobilePrimary Key = "ui.nav.mobilePrimary"
	KeyNavToggle        Key = "ui.nav.toggle"

	// Repeater extras
	KeyRepeaterRemoveItem Key = "ui.repeater.removeItem" // "Remove item {index}"
)

func AllKeys 

func AllKeys() []Key

AllKeys returns every translation Key constant declared by this package. Used by completeness tests to assert that adding a new Key without a matching Defaults entry is a build-breaking error.

Keep this in sync with the const block above. The TestAllKeysCoversAllPackageConstants test cross-checks against the Defaults map so stale entries here are caught at test time.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.