Hiccup
A Clojure's Hiccup inspired macro. At the moment support for inline code execution is not guaranteed. The main objective of this lib is to prevent unclosed html tags.
Basic elements:
The macro `hiccup! receives a mutable string as the first argument and mutates the string to emit the HTML. The order of the elements is:
tagas the first element.- Optional attribute inside the tag should follow the tag name as
{attribute1=>"value1 value2 ... valuen", attr=>"value"}. Also, the attributes should be inside{...}and separate each key value pair by,. The element should be written askey=>"value", where key is a symbol, followed by an arrow (=>), and then the value as a string"value". - After (Optional) the tag name or the attributes
{...}you could include[...]that can have other tags, such asp["text"]or regular string values. - Inside the
[...]you also can substitute your string for some simple rust code inside a(...). This can bem something likep[format!("{:?}", 3 + 4)]ordiv[(x)]where x was defined in the outside.
Differences between Clojure and Rust Hiccup:
- Clojure:
[:a {:href "http://github.com"} "GitHub"] - Rust:
a{href=>"http://github.com"}["GitHub"]
Usage
Add dependency to Cargo.toml:
[dependencies]
hiccup = "0.2.5"
Code example with hiccup! macro:
use hiccup::hiccup;
fn main() {
let mut html = String::new();
let _ = hiccup!(&mut html,
html[
head[meta{name=>"author", content=>"Julia Naomi"}
title["Hiccup guide"]]
body{class=>"amazing hiccup guide"}[
h1{font=>"bold", color=>"red"}["Hiccup is the best!"]
p["please lookup clojure's hiccup for better ideas on this macro"]]
]);
assert_eq!(html,"<html><head><meta name=\"author\" content=\"Julia Naomi\"/>\
<title>Hiccup guide</title></head><body class=\"amazing hiccup guide\">\
<h1 font=\"bold\" color=\"red\">Hiccup is the best!</h1>\
<p>please lookup clojure\'s hiccup for better ideas on this macro</p></body></html>");
}
With remote code execution:
let mut html_inner = String::new();
let mut html_outer = String::new();
let x = "inner my str";
let y = "my str2";
let z = "my str3";
let _ = hiccup!(&mut html_inner,
div[
div{hello=>"inner world"}[(x)]
]
);
let _ = hiccup!(&mut html_outer,
html[
body{class=>"amazing hiccup guide"}[
p["please lookup clojure's hiccup for better ideas on this macro"]
div[
div{hello=>"world"}[(html_inner)]
div[(y.to_owned() + " " + z)]
p["bye"]
]
]
]);
assert_eq!(html_outer,"<html><body class=\"amazing hiccup guide\">\
<p>please lookup clojure\'s hiccup for better ideas on this macro</p>\
<div><div hello=\"world\"><div><div hello=\"inner world\">inner my str</div></div></div>\
<div>my str2 my str3</div><p>bye</p></div></body></html>");
FAQs
- Is it possible tu use this lib as an XML templating?
Yes, I added a more generic XML case to the tests recently
fn main() {
let mut out = String::new();
let _ = hiccup!(&mut out,
xml{metas=>"I forgot them all", version=>"any version"}[
family[name{name=>"Rubiechiov", origin=>"Kazakhstan"}]
members{class=>"close family"}[
member{age=>"oldest", color=>"yellow"}["some name"]
member{age=>"mid-age", color=>"yellow"}["some other name"]
member{age=>"yougest", color=>"brown"}["Julia"]]
]);
assert_eq!(out,"<xml metas=\"I forgot them all\" version=\"any version\"><family>\
<name name=\"Rubiechiov\" origin=\"Kazakhstan\"/></family><members class=\"close family\">\
<member age=\"oldest\" color=\"yellow\">some name</member>\
<member age=\"mid-age\" color=\"yellow\">some other name</member>\
<member age=\"yougest\" color=\"brown\">Julia</member></members></xml>");
}
Contribution
Add the feature you included in the macro as the name of the PR with tests
2 Dec 13, 2021
686 Jan 5, 2023
1 Oct 30, 2021
140 Jan 4, 2023
4 Apr 20, 2022
6 Oct 19, 2022
3 Aug 21, 2022
4 Feb 16, 2024
6.3k Jan 3, 2023
3 Jan 2, 2023
922 Dec 27, 2022
722 Dec 27, 2022
23 Jul 15, 2022
3 Nov 23, 2023
0 Feb 17, 2022
41 Nov 1, 2022
35 Aug 18, 2022
1.4k Jan 1, 2023
23 Jul 15, 2022
1.4k Jan 1, 2023
267 Dec 11, 2022
1 Jan 19, 2022
249 Dec 19, 2022
337 Jan 8, 2023
2.5k Jan 1, 2023
2k Jan 5, 2023
208 May 10, 2022
160 Jul 26, 2022