# Localization (i18n)
Avo leverages Rails powerful I18n translations module. When you run
bin/rails avo:install Rails will generate for you the
avo.en.yml translation file. This file will automatically be injected into the I18n translations module.
# Localizing resources
Let's say you want to localize a resource. All you need to do is add a
self.translation_key class attribute in the
Resource file. This will tell Avo to use that translation key to localize this resource. This will change the labels of that resource everywhere in Avo.
# app/avo/resources/user_resource.rb class UserResource < Avo::BaseResource self.title = :name self.translation_key = 'avo.resource_translations.user' end
# avo.es.yml es: avo: dashboard: 'Dashboard' # ... other translation keys resource_translations: user: zero: 'usuarios' one: 'usuario' other: 'usuarios'
# Localizing fields
Similarly, you can even localize fields. All you need to do is add a
translation_key: option on the field declaration.
# app/avo/resources/project_resource.rb class ProjectResource < Avo::BaseResource self.title = :name field :id, as: :id # ... other fields field :files, as: :files, translation_key: 'avo.field_translations.file' end
# avo.es.yml es: avo: dashboard: 'Dashboard' # ... other translation keys field_translations: file: zero: 'archivos' one: 'archivo' other: 'archivos'
# Setting the locale
Setting the locale for Avo is simple. Just use the
config.locale = 'en-US' config attribute.
Avo.configure do |config| config.locale = 'en-US' end
# Re-generate the locale
When updating Avo please run
bin/rails generate avo:locales to re-generate the locales file.
If you try to localize your resources and fields and it doesn't seem to work please be aware of the following.
# Advanced localization is a Pro feature
Localizing strings in Avo will still work using Rails'
I18n mechanism, but localizing fileds and resources require a
Pro or above license.
The reasoning behind this is that deep localization is a more advanced feature that usually falls in the commercial realm. If you create commercial products or apps for clients, and make revenue using Avo, we'd love to get your support to be able to maintain it and ship new features going forward.
# The I18n.t method defaults to the name of that field/resource
Internally the localization works like so
I18n.t(translation_key, count: 1, default: default) where the
default is the computed field/resource name. So check the structure of you translation keys.
# config/locales/avo.pt-BR.yml pt-BR: avo: field_translations: file: zero: 'arquivos' one: 'arquivo' other: 'arquivos' resource_translations: user: zero: 'usuários' one: 'usuário' other: 'usuários'