Render Elixir data-structures to HTML. Inspired by Hiccup.
Sneeze is available from Hex.pm:
def deps do
[{:sneeze, "~> 2.0"}]
endThe Sneeze.render/1 function will render a list of 'nodes' to html. A node can be any of:
- A tag:
[:br] - A tag with a body:
[:p, "hello"] - A tag with attributes:
[:input, %{type: "text", class: "form-field", name: "widget-input"}] - A tag with attributes and a body:
[:p, %{class: "article-content"}, "hello"] - A bare, stringable node:
22 - A "raw html" node, which will not be escaped:
[:__@raw_html, "<span>derp</span>"]
Of course, the body of any node can be an arbitrary number of other nodes, like so:
[:p, %{id: "status"}, [:span, "woo"]]
The Sneeze.render_iodata/1 function returns an iodata list, which can be more performant in cases where you are passing the result to a function that accepts iodata.
Sneeze.render([:p %{class: "greeting"} "hello world"])
# => <p class="greeting">hello world</p>
Sneeze.render([:br])
# => <br />
Sneeze.render([:span, "<a>will be escaped</a>"])
# => <span><a>will be escaped</a></span>;
Sneeze.render([:div, [:__@raw_html, "<span>totally not escaped</span>"]])
# => <div><span>totally not escaped</span></div>
Sneeze.render(
[:ul, %{class: "super-cool-list"},
[:li,
[:a, %{href: "/"}, "Home"]],
[:li,
[:a, %{href: "/about"}, "About"]],
[:li,
[:a, %{href: "/contact"}, "Contact"]]]
)
# => <ul class="super-cool-list"><li><a href="/">Home</a></li>...</ul
Sneeze.render([
[:__@raw_html, "<!DOCTYPE html>"],
[:head,
[:title, "wat"]],
[:body,
[:div, %{id: "main-content"}, "hello"]]
]
# => <!DOCTYPE html><head><title>wat</title></head><body><div id="main-content">hello</div></body>
Sneeze.render_iodata([:a, %{href: "example.com"}, "hello"])
# => [
# ["<", "a", [[" ", "href", "=\"", "example.com", "\""]], ">"],
# [["hello"]],
# ["</", "a", ">"]
# ]
If you're using sneeze and getting surprising/screwy results, please open an issue.
Documentation can be found on hexdocs.
See cold for a demo of how to use Sneeze with Plug.
Open an issue or pull-request on GitHub, all contributions welcome! :)
- Improved performance! (#19)
- Attributes are now sorted before being rendered. This fixes an issue found when upgrading to OTP 26 (#17)
- A new
Sneeze.render_iodata/1function - Various modernizations, dependency upgrades
- Upgrade
html_entities
- Add
html_entitiesto application list
- Better performance, using iolists instead of string-concatination