Module: ActionView::Helpers::TranslationHelper
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
ActionDispatch::DebugView,
::ActionView::Base ,
::ActionView::Helpers ,
::ActionView::TestCase ,
::ActionView::TestCase::Behavior
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::ActiveSupport::Concern
|
|
Instance Chain:
|
|
Defined in: | actionview/lib/action_view/helpers/translation_helper.rb |
Overview
Action View Translation Helpers
Constant Summary
-
MISSING_TRANSLATION =
private
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 122-(2**60)
-
NO_DEFAULT =
private
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 125[].freeze
TagHelper
- Included
ARIA_PREFIXES, BOOLEAN_ATTRIBUTES, DATA_PREFIXES, PRE_CONTENT_STRINGS, TAG_TYPES
Class Method Summary
::ActiveSupport::Concern
- Extended
class_methods | Define class methods from given block. |
included | Evaluate given block in context of base class, so that you can write class macros here. |
prepended | Evaluate given block in context of base class, so that you can write class macros here. |
Instance Attribute Summary
-
#raise_on_missing_translations
rw
Specify whether an error should be raised for missing translations.
Instance Method Summary
-
#l(object, **options)
Alias for #localize.
-
#localize(object, **options)
(also: #l)
Delegates to
I18n.localize
with no additional functionality. -
#t(key, **options)
Alias for #translate.
-
#translate(key, **options)
(also: #t)
Delegates to
I18n#translate
but also performs three additional functions.
TagHelper
- Included
#cdata_section | Returns a CDATA section with the given |
#class_names | Alias for TagHelper#token_list. |
#content_tag | Returns an HTML block tag of type |
#escape_once | Returns an escaped version of |
#tag | Returns an HTML tag. |
#token_list | Returns a string of tokens built from |
OutputSafetyHelper
- Included
#raw | This method outputs without escaping a string. |
#safe_join | This method returns an HTML safe string similar to what |
#to_sentence | Converts the array to a comma-separated sentence where the last element is joined by the connector word. |
CaptureHelper
- Included
#capture | The capture method extracts part of a template as a string object. |
#content_for | Calling |
#content_for? |
|
#provide | The same as |
DSL Calls
included
[ GitHub ]17 18 19
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 17
included do mattr_accessor :debug_missing_translation, default: true end
Instance Attribute Details
#raise_on_missing_translations (rw)
Specify whether an error should be raised for missing translations.
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 15
singleton_class.attr_accessor :raise_on_missing_translations
Instance Method Details
#l(object, **options)
Alias for #localize.
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 119
alias :l :localize
#localize(object, **options) Also known as: #l
Delegates to I18n.localize
with no additional functionality.
See www.rubydoc.info/gems/i18n/I18n/Backend/Base:localize for more information.
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 116
def localize(object, ** ) I18n.localize(object, ** ) end
#t(key, **options)
Alias for #translate.
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 110
alias :t :translate
#translate(key, **options) Also known as: #t
Delegates to I18n#translate
but also performs three additional functions.
First, it will ensure that any thrown MissingTranslation
messages will be rendered as inline spans that:
-
Have a
translation-missing
class applied -
Contain the missing key as the value of the
title
attribute -
Have a titleized version of the last key segment as text
For example, the value returned for the missing translation key "blog.post.title"
will be:
<span
class="translation_missing"
title="translation missing: en.blog.post.title">Title</span>
This allows for views to display rather reasonable strings while still giving developers a way to find missing translations.
If you would prefer missing translations to raise an error, you can opt out of span-wrapping behavior globally by setting config.i18n.raise_on_missing_translations = true
or individually by passing raise: true
as an option to translate
.
Second, if the key starts with a period translate
will scope the key by the current partial. Calling translate(".foo")
from the people/index.html.erb
template is equivalent to calling translate("people.index.foo")
. This makes it less repetitive to translate many keys within the same partial and provides a convention to scope keys consistently.
Third, the translation will be marked as html_safe
if the key has the suffix “_html” or the last element of the key is “html”. Calling translate("footer_html")
or translate("footer.html")
will return an HTML safe string that won’t be escaped by other HTML helper methods. This naming convention helps to identify translations that include HTML tags so that you know what kind of output to expect when you call translate in a template and translators know which keys they can provide HTML values for.
To access the translated text along with the fully resolved translation key, translate
accepts a block:
<%= translate(".relative_key") do |translation, resolved_key| %>
<span title="<%= resolved_key %>"><%= translation %></span>
<% end %>
This enables annotate translated text to be aware of the scope it was resolved against.
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 73
def translate(key, ** ) return key.map { |k| translate(k, ** ) } if key.is_a?(Array) key = key&.to_s unless key.is_a?(Symbol) alternatives = if .key?(:default) [:default].is_a?(Array) ? .delete(:default).compact : [ .delete(:default)] end [:raise] = true if [:raise].nil? && TranslationHelper.raise_on_missing_translations default = MISSING_TRANSLATION translation = while key || alternatives.present? if alternatives.blank? && ! [:raise].nil? default = NO_DEFAULT # let I18n handle missing translation end key = scope_key_by_partial(key) translated = ActiveSupport::HtmlSafeTranslation.translate(key, **, default: default) break translated unless translated == MISSING_TRANSLATION if alternatives.present? && !alternatives.first.is_a?(Symbol) break alternatives.first && I18n.translate(nil, **, default: alternatives) end first_key ||= key key = alternatives&.shift end if key.nil? && !first_key.nil? translation = missing_translation(first_key, ) key = first_key end block_given? ? yield(translation, key) : translation end