by Lenin Compres
P5 editor examples by John Henry Thompson
DOM.js is a lightweight JavaScript library for creating and manipulating DOM elements using JavaScript objects or JSON models. It simplifies DOM interactions, enabling dynamic and efficient web development. With DOM.js, you can effortlessly create elements, manage attributes and styles, bind properties, and handle events.
Click here to learn what is the DOM.
Features:
- Create and manage DOM elements using JavaScript objects or JSON.
- Bind properties to elements for dynamic updates.
- Extend HTML elements with custom methods.
- Integrate seamlessly with libraries like P5.js.
The following is all the HTML we are going to need for the entirety of this documentation. It is our index.html file. The rest of our code will be in javaScript (main.js). We will not need CSS either.
<!DOCTYPE html>
<html lang="en">
<head>
<script src="https://cdn.jsdelivr.net/gh/lenincompres/DOM.js@latest/DOM.js"></script>
</head>
<body>
<script src="main.js"></script>
</body>
</html>Use the DOM.set method to create and append elements:
const model = {
tag: 'div',
id: 'container',
children: [
{
tag: 'h1',
innerHTML: 'Hello, World!'
},
{
tag: 'p',
innerHTML: 'This is a paragraph.'
}
]
};
DOM.set(model);You may also use the tags as key properties and values as their innerHTML.
DOM.set({
header: {
h1: 'Page built with DOM.set',
},
main: {
article: {
h2: 'Basic DOM element',
p: '<b>This</b> is a paragraph.',
},
},
footer: {
p: 'Made with DOM.js',
},
});You may also invoke the set method directly on an element to model it.
someElement.set({
h3: 'Hello world',
p: 'This is a <b>paragraph</b>.',
});The new h1 and p elements will be appended to the element. See live code sample
Other ways to invoke DOM.set
You may provide DOM.set with an element where the model structure should be created.
DOM.set(
{
h1: 'Hello world',
p: 'This <b>is</b> a paragraph.',
},
someElement
);You may also provide a string to indicate the tag for a new element where the DOM structure will be created. The following example creates a main element inside the someElement. It returns this main element.
DOM.set({
h1: "Hello world",
p: "This is <b>a</b> paragraph.";
}, "main", someElement);DOM.set is agnostic about the order of the arguments that follow the first (model structure):
- An element is where the model should be created instead of document.body.
- A string is a tag for a new element to be created.
The following code creates and returns a main element, and does not add it to the dom.
let mainElement = DOM.set(
{
h1: 'Hello world',
p: 'This is <b>a</b> paragraph.',
},
'main'
);The following code creates an image element without adding it to the document body first.
let mainImage = DOM.set(
{
alt: 'Hello world',
src: 'myImage.png',
},
'img',
false,
);For DOM.set, a boolean argument with a false value indicates that this element should not be appended to the document body. A value of true would mean that the element (and/or model) will replace all the current content in the DOM (or in the element invoking the set method).
DOM.set recognizes properties in the model structure, such as attributes or event handlers.
DOM.set({
input: {
id: 'myInput',
placeholder: 'Type value here',
onchange: (event) => alert(myInput.value),
click: (event) => alert('It recognized event types to add listeners; as well as event methods.'),
},
button: {
id: 'goBtn',
innerText: 'Go',
addEventListener: {
type: 'click',
listener: (event) => (myInput.value = 'Button pressed'),
},
},
});
myInput.style.border = 'none';NOTE:
- Providing an element with an id will create a global variable (with that name) to hold that element.
- Use text or innerText, html or innerHTML, or simply content for the element's inner content.
The set method allows you to modify attributes, styles, event handlers, and content of existing elements with just one call.
myElement.set({
padding: '0.5em 2em',
backgroundColor: 'lavender',
text: 'Some text',
});You can set up the class attribute of the element passing a string to replace the content of the class tribute.
myElement.set({
class: 'my-classname other-classname',
});Or, use an array, to add classes to the classList without replacing existing ones.
myElement.set({
class: ['my-classname', 'other-classname'],
});You may also use and object to add or remove a class.
myElement.set({
class: {
classname: false, // this removes the class "classname"
'other-classname': true, // this adds the class
'yet-another': isAnother, // this adds or removes depending of the truthy o falsy value of isAnother
},
});DOM.set() returns a new element and appends it to the DOM when provided a tag as a second parameter. The following returns a paragraph.
const myParagraph = DOM.set(
{
padding: '0.5em 2em',
backgroundColor: 'lavender',
text: 'Some text',
},
'p'
);
DOM.set({
header: {
h1: 'loading an element',
p: 'The element was create before the DOM is set.',
},
main: {
p: myParagraph,
},
});NOTE:
- A third boolean parameter of value false would tell set not to append the new element to the DOM. While a true value would append the new element and remove everything else in the DOM's content.
Just as any element, you may invoke the set method on the head element. Many of its properties can be set directly. It will even link fonts and make them available as font-family styles.
document.head.set({
title: 'Title of the webpage',
charset: 'UTF-8',
icon: 'icon.ico',
keywords: 'website,multiple,keywords',
description: 'Website created with DOM.js',
viewport: {
width: 'device-width',
initialScale: 1,
},
meta: {
name: 'color-scheme',
content: 'dark',
},
link: {
rel: 'style',
href: 'style.css',
},
style: {
type: 'css',
content: 'body{ margin:0; background-color:gray; }',
},
script: {
type: 'module',
src: 'main.js',
},
font: {
fontFamily: 'myFont',
src: 'fonts/myFont.ttf',
},
});The method also understands default values for properties like link, style, font, or script elements; and accepts arrays of elements for them.
document.head.set({
link: 'style.css',
style: 'body{ margin:0; backgroundColor: gray; }',
script: ['main.js', 'lib/dependecies.js'],
font: [
'fonts/myFont.ttf',
{
fontFamily: 'aFont',
src: 'fonts/anotherName.ott',
},
],
});Note how set recognizes common head information (icon, charset, keywords, description, etc). In fact, the DOM.set method recognizes these as well, and adds them on the document.head instead of the body.
const myHeader = DOM.set(
{
h1: 'Page built with DOM.set',
},
'header'
);
const myMain = DOM.set(
{
article: {
h2: 'Basic DOM element',
p: '<b>This</b> is a paragraph.',
},
},
'main'
);
const myFooter = DOM.set(
{
p: 'Made with DOM.set',
},
'footer'
);
DOM.set({
title: 'Title of the webpage',
charset: 'UTF-8',
icon: 'icon.ico',
keywords: 'website,multiple,keywords',
description: 'Website created with DOM.set',
header: myHeader,
main: myMain,
footer: myFooter,
});Use arrays to create multiple consecutive elements of the same kind.
DOM.set({
ul: {
li: ['First item', 'Second item', 'A third one, for good meassure'],
},
});Declaring the array inside a content property allows you to set other properties for all the elements in the array.
DOM.set({
ul: {
li: {
id: 'listedThings',
style: 'font-weight:bold',
height: '20px ',
content: ['first item', 'second item', 'a third for good meassure'],
},
},
});
// The following makes the second element yellow
listedThings[1].set({
backgroundColor: 'yellow',
});When an id is provided, a global variable holding the array of elements is created. In fact, if you give several elements the same id, DOM.set will group them in one global array.
Arrays can be used to create consecutive element of different types; just indicate their tag as a property.
DOM.set({
main: {
elements: [
{
tag: 'p',
text: 'this one is a paragraph.',
},
{
tag: 'img',
src: 'thesource.jpg',
alt: 'This one is an image',
},
{
tag: 'p',
text: 'another paragraph',
},
],
},
});You can name these elements anything—in this case they were named elements—; another recommended name is children. Each will be assigned a specified tag. But, you must avoid using known property names like: content, margin, text, etc. Using a plural word for the property helps avoid this mistake.
Similarly, if you give DOM.set an array, it assumes it is an array of elements, and will create them as divs, or any tag property they possess.
DOM.set([
{
tag: 'p',
text: 'this one is a paragraph.',
},
{
tag: 'img',
src: 'thesource.jpg',
alt: 'This one is an image',
},
{
tag: 'p',
text: 'another paragraph',
},
]);Asign a string to the style property to update the inline style of the element—replacing any previous value.
const myMain = DOM.set(
{
style: 'margin: 20px; font-family: Tahoma; background-color: gray;',
content: 'The style is in the style attribute of the main element.',
},
'main'
);
DOM.set({
header: {
h1: 'Example of styling',
},
main: myMain,
footer: 'the footer',
});Asign a structural object to the style to update individual style properties—use names in camelCase.
const myMain = DOM.set(
{
style: {
margin: '20px',
fontFamily: 'Tahoma',
backgroundColor: 'gray',
},
content: {
h1: 'Styled Main Element',
p: 'This manages the style values individually.',
},
},
'main'
);
DOM.set({
header: {
h1: 'Example of styling',
},
main: myMain,
footer: 'the footer',
});This is equivalent to using the style property of DOM elements.
Styles may be assigned without an emcompasing style property. The previous code could be written as follows.
const myMain = DOM.set(
{
margin: '20px',
fontFamily: 'Tahoma',
backgroundColor: 'gray',
h1: 'Styled Main Element',
p: 'This manages the style values individually.',
},
'main'
);
DOM.set({
header: {
h1: 'Example of styling',
},
main: myMain,
footer: 'the footer',
});The style, attribute, and content properties are useful for organizing the model structure, and to clarify what kind of property you are trying to set. If DOM.js is not setting a value in the right property you intended to (style, attributes, events, etc.), you should put this key/value pair inside one of these wrapping or organizing properties. Yet, DOM.set interprets structural properties to match attributes, styles, event handlers and element tags.
If style has a content property, an element with a style tag and CSS content is created. Click here to learn about CSS.
const myMain = DOM.set(
{
style: {
lang: 'scss',
content: 'main { margin: 20px; font-family: Tahoma; color: gray; }',
},
content: 'This style is applied to all MAIN elements in the page.',
},
'main'
);
DOM.set({
header: {
h1: 'Example of styling',
},
main: myMain,
footer: 'the footer',
});This method is discouraged, since it will affect all elements in the DOM not just the one invoking set.
Use css: in your model structure to create styling rules that apply only to the current element and its children.
const myMain = DOM.set(
{
css: {
margin: '20px',
fontFamily: 'Tahoma',
backgroundColor: 'gray',
nav: {
a: {
backgroundColor: 'silver',
hover: {
backgroundColor: 'gold',
},
},
},
},
nav: {
a: [
{
href: 'home.html',
content: 'HOME',
},
{
href: 'gallery.html',
content: 'GALLERY',
},
],
},
},
'main'
);
DOM.set({
header: {
h1: 'Example of styling',
},
main: myMain,
footer: 'the footer',
});The CSS is added to the document.head's style element under the id of the element where it is created. If the element doesn't have an id, a unique one is provided for it.
Nested selectors affect all children in the hierarchy of the DOM.
- tag_: Use a trailing underscore (_) to affect only immediate children of the element.
- _class, tag_class: Leading underscores and any other in the selector are turned into (.) to indicate classes.
- __class: Two leading underscores mean the class is applied to the parent selector.
mainArea.css({
a: {
// #mainArea a
backgroundColor: 'gray',
__primary: {
// #mainArea a.primary
backgroundColor: 'gold',
},
},
a_: {
// #mainArea>a
backgroundColor: 'silver',
__primary: {
// #mainArea>a.primary
backgroundColor: 'red',
},
},
a_primary: {
// #mainArea a.primary
backgroundColor: 'gold',
},
_primary: {
// #mainArea .primary
backgroundColor: 'green',
},
a_primary_: {
// #mainArea>a.primary
backgroundColor: 'red',
},
});Any element's property (attribute, content, style, content or event handler) can be bound to a Binder object. When the value property of this object changes, it automatically updates all element properties' bound to it.
const myBinder = new Binder('Default value');
const myMain = DOM.set(
{
input: {
value: myBinder,
},
p: {
text: myBinder,
},
button: {
text: 'Go',
onclick: (event) => (myBinder.value = 'Go was clicked.'),
},
},
'main'
);
DOM.set({
header: {
h1: 'Example of binding',
},
main: myMain,
footer: 'the footer',
});Using the .as() method of the binders, you may provide a function that returns the correct value to assign to the element's property based on the value of the binder, or provide an object model to map the values to.
const fieldEnabled = new Binder(false);
const myMain = DOM.set(
{
div: {
style: {
background: fieldEnabled.as({
true: 'green',
false: 'gray',
}),
},
input: {
enabled: fieldEnabled,
value: fieldEnabled.as((value) => `The field is: ${value}.`),
},
button: {
class: {
enablebutton: fieldEnabled, // classes passed as object keys can be bound as well.
},
text: 'toggle',
onclick: () => (fieldEnabled.value = !fieldEnabled.value),
},
},
},
'main'
);
DOM.set({
header: {
h1: 'Example of binding',
},
main: myMain,
footer: 'the footer',
});Classes in the classList can be bound to a binder as well. They changing value of true or false will determine if a class is added or removed.
You may call the bind method of a binder and provide the element and property to be bound to it.
myBinder.bind(someElement, 'text', (value) => `The field is: ${value}.`);The bind method is agnostic about the order of the arguments provided. An element is the target, a string the property to bind, and a function will return the appropriate value to update the element.
The DOM.binder function may also be called with initial binding settings. The first argument will be the value of the binder.
let myBinder = DOM.binder(true, someElement, 'text', (value) => `The field is: ${value}.`);You may update the value of other binders by binding them.
myBinder.bind(someOtherBinder, (value) => (value ? 'red' : 'blue'));You may add listerner methods to be called when a binder is updated.
myBinder.addListener((value) => alert('The value was updated to: ' + value));If instead of a function or an object model, the binding is given an array, it assumes these outcomes to be indexed by the value of the binder.
DOM.set({
background: fieldEnabled.as(['gray', 'green']),
});
myBinder.bind(someElement, 'text', ['field is disabled', 'field is enabled']);
myBinder.bind(someOtherBinder, ['blue', 'red']);Note that if the value is a boolean, false would be position 0, and true is position 1.
To create custom HTML elements using the DOM.js approach, we can extend Javascript's HTMLElement class.
// declares the class
class MyElement extends HTMLElement {
constructor(startVal) {
super();
this.valueBinder = new Binder(startVal);
this.set({
width: 'fit-content',
padding: '2em',
margin: '0 auto',
display: 'block',
textAlign: 'center',
backgroundColor: this.valueBinder.as(['red', 'green']),
p: {
text: this.valueBinder,
},
button: {
text: 'toggle',
onclick: (e) => this.toggle(),
},
});
}
set value(val) {
this.valueBinder.value = val;
}
get value() {
return this.valueBinder.value;
}
toggle() {
this.value = !this.value;
}
}
customElements.define('my-element', MyElement);
// instantiate the element
let myElement = new MyElement(true);
DOM.set({
h1: 'Extended HTML element',
MyElement: myElement,
});This method returns an element's property value based on a string provided. It matches it to an attribute, style property, element tag (in the scope), or query selector. If no string is provided, it returns the value property or the innerHTML.
DOM.get('backgroundColor'); // returns the body's background color
document.body.get('backgroundColor'); // same as before
myElement.get('class'); // returns the class attribute of the element
myElement.get('classes'); // returns the classes in the attribute of the element as an array
myElement.get(); // returns the value (in the case of inputs) or the innerHTML
myElement.get('text'); // returns the innerText
myElement.get('article'); // returns the array of article tag elements within someElement's scope
myElement.get('.nice'); // similar to querySelectorAll, but returns an array of elementsYes, DOM.set works for P5.js elements. If you are not familiar with P5.js, please remedy that.
p5.set({
h1: 'Hello world',
p: 'This is a paragraph.',
});When called from p5 or a p5 element, all elements given an id are created as p5 elements, and can execute p5 methods.
someP5Element.set({
h1: 'Hello world',
button: {
id: 'goBtn',
text: 'Go',
mouseClicked: (e) => alert('Go was clicked.'),
},
});
/* goBtn is a p5 Element. */
goBtn.addClass('nice-button');