Type:
Module

The TextHelper module provides a set of methods for filtering, formatting and transforming strings, which can reduce the amount of inline Ruby code in your views. These helper methods extend Action View making them callable within your template files.

Sanitization

Most text helpers by default sanitize the given content, but do not escape it. This means HTML tags will appear in the page but all malicious code will be removed. Let's look at some examples using the simple_format method:

1
2
3
4
5
simple_format('<a href="http://example.com/">Example</a>')
# => "<p><a href=\"http://example.com/\">Example</a></p>"
 
simple_format('<a href="javascript:alert(\'no!\')">Example</a>')
# => "<p><a>Example</a></p>"

If you want to escape all content, you should invoke the h method before calling the text helper.

1
2
simple_format h('<a href="http://example.com/">Example</a>')
# => "<p>&lt;a href=\"http://example.com/\"&gt;Example&lt;/a&gt;</p>"
current_cycle
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

current_cycle(name = "default") Instance Public methods Returns the current

2025-01-10 15:47:30
concat
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

concat(string) Instance Public methods The preferred method of outputting text

2025-01-10 15:47:30
highlight
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

highlight(text, phrases, options = {}) Instance Public methods Highlights one

2025-01-10 15:47:30
cycle
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

cycle(first_value, *values) Instance Public methods Creates a Cycle object whose

2025-01-10 15:47:30
word_wrap
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

word_wrap(text, options = {}) Instance Public methods Wraps the text

2025-01-10 15:47:30
excerpt
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

excerpt(text, phrase, options = {}) Instance Public methods Extracts an excerpt

2025-01-10 15:47:30
truncate
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

truncate(text, options = {}, &block) Instance Public methods Truncates a

2025-01-10 15:47:30
simple_format
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

simple_format(text, html_options = {}, options = {}) Instance Public methods Returns

2025-01-10 15:47:30
reset_cycle
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

reset_cycle(name = "default") Instance Public methods Resets a cycle so that

2025-01-10 15:47:30
safe_concat
  • References/Ruby on Rails/Rails/Classes/ActionView/ActionView::Helpers/ActionView::Helpers::TextHelper

safe_concat(string) Instance Public methods

2025-01-10 15:47:30