Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/attilahorvath/i18n-globals
Adds support for I18n global variables, which will be available for interpolation into every translation.
https://github.com/attilahorvath/i18n-globals
i18n interpolation ruby translation
Last synced: about 7 hours ago
JSON representation
Adds support for I18n global variables, which will be available for interpolation into every translation.
- Host: GitHub
- URL: https://github.com/attilahorvath/i18n-globals
- Owner: attilahorvath
- License: mit
- Created: 2014-05-09T15:11:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-05-24T10:01:25.000Z (over 6 years ago)
- Last Synced: 2024-10-31T12:59:54.817Z (15 days ago)
- Topics: i18n, interpolation, ruby, translation
- Language: Ruby
- Size: 27.3 KB
- Stars: 6
- Watchers: 1
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# I18n::Globals [](https://travis-ci.org/attilahorvath/i18n-globals)
Adds support for I18n global variables, which will be available for interpolation into every translation.
## Description
Extends the Ruby I18n gem with global variables. The globals will be available for interpolation in every translation without explicitly specifying them in a call to `I18n.translate`. The variables can be accessed through `I18n.config.globals`.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'i18n-globals'
```
And then execute:
```sh
$ bundle
```
Or install it yourself as:
```sh
$ gem install i18n-globals
```
## Usage
Add your global variables to the `I18n.config.globals` hash:
```ruby
I18n.config.globals[:company] = 'Initech'
```
Your global variables will then be automatically interpolated into every translation:
```ruby
# The translation of 'greeting' is 'Welcome to %{company}!'
I18n.t 'greeting' # => 'Welcome to Initech!'
```
You can override the globals:
```ruby
I18n.t 'greeting', company: 'Initrode' # => 'Welcome to Initrode!'
```
It is also possible to mix globals and ordinary variables:
```ruby
# The translation of 'signature' is '%{president}, President of %{company}'
I18n.t 'signature', president: 'Bill Lumbergh' # => 'Bill Lumbergh, President of Initech'
```
If you're using Rails, it can be useful to specify your globals in a `before_action`:
```ruby
class EmployeesController < ApplicationController
before_action :set_i18n_globals
# ...
private
def set_i18n_globals
I18n.config.globals[:company] = Company.current.name
end
end
```
Now you can interpolate the `company` variable into every translation in your template:
```html+erb
<%= t 'greeting' %>
<%= t 'signature', president: 'Bill Lumbergh' %>
```
And this would produce:
```html
Welcome to Initech!
Bill Lumbergh, President of Initech
```
## Contributing
1. Fork it ( https://github.com/attilahorvath/i18n-globals/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request