domliteral
v1.3.3
Published
Create DOM nodes from plain JS data literals
Readme
domliteral
Create DOM nodes from plain JS data literals
Getting Started
npm install domliteralIn your script:
const dom = require("domliteral");
// exposes two functions:
dom.parse("hello") // returns a parse tree, mostly just for headless testing
dom.element("hello") // returns an actual DOM element, if you're in a browser context
// common use
const elem = dom.element(["div", {"class": "foo"}, "hello"])
document.body.appendChild(elem);Usage
domliteral allows you to create lightweight, composable view
components in JS without the machinery of templating or React.
function timeParagraph(date) {
return ["p", "The time is: " date]
}
const buttonElement = dom.element(
[
"button",
{ onClick: function(evt) {
document.body.appendChild(dom.element(timeParagraph(new Date())));
},
"Click to write the date"
]
);
document.body.appendChild(buttonElement);If you don't have a full node build environment set up, you can just
<script> it into your page via unpkg:
<script src="https://unpkg.com/domliteral/dist/domliteral.js"></script>For example:
<html>
<body>
<script src="https://unpkg.com/domliteral/dist/domliteral.js"></script>
<script>
var e = ["form", {action: "/", method: "POST"},
["input", {type: "text", value: "my text"}],
["input", {type: "submit", value: "behold!"}]];
document.body.appendChild(domliteral.element(e));
</script>
</body>
</html>Syntax
// simple literals
dom.parse("hello") // => TextNode "hello"
dom.parse(42) // => TextNode "42"
// tagged elements are represented as arrays, where the second selement
// is optionally an object of attributes
dom.parse(["p"]) // => <p></p>
dom.parse(["p", {"class": "foo"}] // => <p class="foo"></p>
// children are any literals that occur after the tag and (optional) attrs.
dom.parse(
["ul",
["li", {"class": "foo"},
"hello"]])
// => <ul><li class="bar">hello</li></ul>
// everything else works like normal, including variables and event handlers
function button(label, alertText) {
return ["button", {onClick: function(event) { alert(alertText); }}, label];
}