simple_format(text, html_options = {}, options = {})
Instance Public methods
Returns text transformed into HTML using simple formatting rules. Two or more
consecutive newlines(\n\n) are considered as a paragraph and
wrapped in <p> tags. One
newline (\n) is considered as a linebreak and a <br
/> tag is appended. This method does not remove the newlines from
the text.
You can pass any HTML attributes into
html_options. These will be added to all created paragraphs.
Options
-
:sanitize- Iffalse, does not sanitizetext. -
:wrapper_tag- String representing the wrapper tag, defaults to"p"
Examples
my_text = "Here is some basic text...\n...with a line break."
simple_format(my_text)
# => "<p>Here is some basic text...\n<br />...with a line break.</p>"
simple_format(my_text, {}, wrapper_tag: "div")
# => "<div>Here is some basic text...\n<br />...with a line break.</div>"
more_text = "We want to put a paragraph...\n\n...right there."
simple_format(more_text)
# => "<p>We want to put a paragraph...</p>\n\n<p>...right there.</p>"
simple_format("Look ma! A class!", class: 'description')
# => "<p class='description'>Look ma! A class!</p>"
simple_format("<blink>Unblinkable.</blink>")
# => "<p>Unblinkable.</p>"
simple_format("<blink>Blinkable!</blink> It's true.", {}, sanitize: false)
# => "<p><blink>Blinkable!</blink> It's true.</p>"
Please login to continue.