Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
I18n translation files for Spree Commerce.
Ruby HTML CoffeeScript CSS

README.md

Spree Internationalization

Build Status Code Climate

This is the Internationalization project for Spree Commerce

See the official Internationalization documentation for more details.

Happy translating!


Installation

Add the following to your Gemfile:

gem 'spree_i18n', github: 'spree-contrib/spree_i18n', branch: 'master'

Run bundle install

You can use the generator to install migrations and append spree_i18n assets to your app spree manifest file.

rails g spree_i18n:install

This will insert these lines into your spree manifest files:

vendor/assets/javascripts/spree/backend/all.js
//= require spree/backend/spree_i18n

vendor/assets/javascripts/spree/frontend/all.js
//= require spree/frontend/spree_i18n

vendor/assets/stylesheets/spree/frontend/all.css
*= require spree/frontend/spree_i18n

Model Translations

We've added support for translating models. The feature uses the Globalize gem to localize model data. So far the following models are translatable:

Product, Promotion, OptionType, Taxonomy, Taxon and Property.

Start your server and you should see a TRANSLATIONS link or a flag icon on each admin section that supports this feature.

The extension contains two configs that allow users to customize which locales should be displayed as options on the translation forms and which should be listed to customers on the frontend. You can set them on an initializer. e.g.

SpreeI18n::Config.available_locales = [:en, :es, :'pt-BR'] # displayed on translation forms
SpreeI18n::Config.supported_locales = [:en, :'pt-BR'] # displayed on frontend select box

ps. please use symbols, not strings. e.g. :'pt-BR' not just 'pt-BR'. Otherwise you may get unexpected errors

Or if you prefer they're also available on the admin UI general settings section.

Every record needs to have a translation. If by any chance you remove spree_i18n from your Gemfile, add some records and then add spree_i18n gem back you might get errors like undefined method for nilClass because Globalize will try fetch translations that do not exist.


Contributing

See corresponding guidelines


Copyright (c) 2010-2015 Spree Commerce Inc. and other contributors. released under the New BSD License

Something went wrong with that request. Please try again.