Phoenix.HTML
Helpers for working with HTML strings and templates.
When used, it imports the given modules:
Phoenix.HTML- functions to handle HTML safety;Phoenix.HTML.Tag- functions for generating HTML tags;Phoenix.HTML.Form- functions for working with forms;Phoenix.HTML.Link- functions for generating links and urls;
HTML Safe
One of the main responsibilities of this module is to provide convenience functions for escaping and marking HTML code as safe.
By default, data output in templates is not considered safe:
<%= "<hello>" %>will be shown as:
<hello>User data or data coming from the database is almost never considered safe. However, in some cases, you may want to tag it as safe and show its “raw” contents:
<%= raw "<hello>" %>Keep in mind most helpers will automatically escape your data and return safe content:
<%= tag :p, "<hello>" %>will properly output:
<p><hello></p>Summary↑
| html_escape(safe) | Escapes the HTML entities in the given term, returning iodata |
| raw(value) | Marks the given content as raw |
| safe_to_string(arg) | Converts a safe result into a string |
| sigil_E(expr, opts) | Provides |
| sigil_e(expr, opts) | Provides |
Types ↑
safe :: {:safe, iodata}
Guaranteed to be safe
May be safe or unsafe (i.e. it needs to be converted)
Functions
Specs:
Escapes the HTML entities in the given term, returning iodata.
iex> html_escape("<hello>")
{:safe, "<hello>"}
iex> html_escape('<hello>')
{:safe, ["<", 104, 101, 108, 108, 111, ">"]}
iex> html_escape(1)
{:safe, "1"}
iex> html_escape({:safe, "<hello>"})
{:safe, "<hello>"}Specs:
Marks the given content as raw.
This means any HTML code inside the given string won’t be escaped.
iex> raw("<hello>")
{:safe, "<hello>"}
iex> raw({:safe, "<hello>"})
{:safe, "<hello>"}Specs:
Converts a safe result into a string.
Fails if the result is not safe. In such cases, you can
invoke html_escape/1 or raw/1 accordingly before.
Macros
Provides ~E sigil with HTML safe EEx syntax inside source files.
This sigil does not support interpolation and is should be prefered
rather than ~e.
iex> ~E"""
...> Hello <%= "world" %>
...> """
{:safe, [[["" | "Hello "] | "world"] | "\n"]}Provides ~e sigil with HTML safe EEx syntax inside source files.
iex> ~e"""
...> Hello <%= "world" %>
...> """
{:safe, [[["" | "Hello "] | "world"] | "\n"]}