typed-dom
Advanced tools
A value-level and type-level DOM builder.
Visualize DOM structures and Assist DOM access using static types.
const dom: El<"article", HTMLElement, {
style: El<"style", HTMLStyleElement, string>;
title: El<"h1", HTMLHeadingElement, string>;
content: El<"ul", HTMLUListElement, readonly El<"li", HTMLLIElement, string>[]>;
}>
DOM manipulation must be easy and reliable, but it doesn't need virtual DOM or unique syntax. Typed-DOM is a minimal API set for easy and reliable DOM manipulation.
| Product | Access | Dependence | Extensibility | Problem |
|---|---|---|---|---|
| Typed-DOM | Type | Interface | API, Fork | Slow construction |
| jQuery | Query | Implementation | Plugin | Breakable, Implicit dependency |
| React | Create all and search difference | Implementation | Component | Breakable, Waste, Complex, Severely dependent, Incomplete vain reinvention of the browser |
Build a Typed-DOM component with styling.
$scope selectors are replaced with :host, #<id>, or .<generated-id>.
import { HTML } from 'typed-dom';
const dom = HTML.article({
style: HTML.style('$scope { color: red; }'),
title: HTML.h1('Title'),
content: HTML.ul([
HTML.li('item'),
HTML.li('item'),
]),
});
Then this component has the following readable static type generated by type inference.
const dom: El<"article", HTMLElement, {
style: El<"style", HTMLStyleElement, string>;
title: El<"h1", HTMLHeadingElement, string>;
content: El<"ul", HTMLUListElement, readonly El<"li", HTMLLIElement, string>[]>;
}>
// Note: El type is defined as follows.
export interface El<
T extends string = string,
E extends Element = Element,
C extends El.Children = El.Children,
> {
readonly tag: string;
readonly element: E;
get children(): El.Getter<C>;
set children(children: El.Setter<C>);
}
export namespace El {
export type Children =
| Children.Void
| Children.Node
| Children.Text
| Children.Array
| Children.Struct;
export namespace Children {
export type Void = void;
export type Node = DocumentFragment;
export type Text = string;
export type Array = readonly El[];
export type Struct = { [field: string]: El; };
}
export type Getter<C extends El.Children> =
C extends Children.Struct ? C :
C;
export type Setter<C extends El.Children> =
C extends Children.Struct ? Partial<C> :
C;
export type Factory<
M extends TagNameMap,
C extends El.Children = El.Children,
> =
<T extends keyof M & string>(
baseFactory: BaseFactory<M>,
tag: T,
attrs: Attrs<Extract<M[T], Element>>,
children: C,
) => M[T];
}
Using the static type, you can see the internal structure and can safely access to and manipulate it.
// Inspect
dom.element.outerHTML; // '<article class="RANDOM"><style>.RANDOM { color: red; }</style><h1>Title</h1><ul><li>item</li><li>item</li></ul></article>'
dom.children.title.element.outerHTML; // '<h1>Title</h1>'
dom.children.title.children; // 'Title'
dom.children.content.element.outerHTML; // '<ul><li>item</li><li>item</li></ul>'
dom.children.content.children[0].children; // 'item'
// Update
// - Text
dom.children.title.children = 'Text';
dom.children.title.element.outerHTML; // '<h1>Text</h1>'
// - Array
dom.children.content.children = [
HTML.li('Array'),
];
dom.children.content.element.outerHTML; // '<ul><li>Array</li></ul>'
// - Struct
dom.children = {
title: HTML.h1('Struct'),
};
dom.children.title.element.outerHTML; // '<h1>Struct</h1>'
dom.children.title = HTML.h1('title');
dom.children.title.element.outerHTML; // '<h1>title</h1>'
Typed-DOM supports custom elements but they are unrecommended since most purposes of customizations can be realized by customizing proxies or APIs instead of elements.
Define composable DOM components.
import { HTML, El } from 'typed-dom';
class Component implements El {
private readonly dom = HTML.section({
style: HTML.style('$scope { color: red; }'),
content: HTML.ul([
HTML.li('item'),
]),
});
public readonly tag = this.dom.tag;
public readonly element = this.dom.element;
public get children() {
return this.dom.children.content.children;
}
public set children(children) {
this.dom.children.content.children = children;
}
}
Switch to shadow DOM. Transparently accessible to elemets in shadow DOM.
import { Shadow, HTML, El } from 'typed-dom';
class ShadowComponent implements El {
private readonly dom = Shadow.section({
style: HTML.style('$scope { color: red; }'),
content: HTML.ul([
HTML.li('item'),
]),
});
public readonly tag = this.dom.tag;
public readonly element = this.dom.element;
public get children() {
return this.dom.children.content.children;
}
public set children(children) {
this.dom.children.content.children = children;
}
}
Define autonomous DOM components which orient choreography, not orchestration. This coroutine supports the actor model and the supervisor/worker pattern (using spica/supervisor).
import { Shadow, HTML, El } from 'typed-dom';
import { Coroutine } from 'spica/coroutine';
class Component extends Coroutine<number> implements El {
constructor() {
super(async function* (this: Component) {
let count = 0;
this.text = count;
while (true) {
this.element.isConnected || await new Promise<unknown>(resolve =>
this.element.addEventListener('connect', resolve, { once: true }));
yield this.text = ++count;
}
}, { trigger: 'element', interval: 100 });
}
private set text(count: number) {
this.children = `Counted ${count} times.`;
}
private readonly dom = Shadow.section({ onconnect: '' }, {
style: HTML.style('$scope { color: red; }'),
content: HTML.p(''),
});
public readonly tag = this.dom.tag;
public readonly element = this.dom.element;
public get children() {
return this.dom.children.content.children;
}
public set children(children) {
this.dom.children.content.children = children;
}
}
Create a helper factory function for i18n.
import { HTML, El, html, define } from 'typed-dom';
import i18next from 'i18next';
const translator = i18next.createInstance({
lng: 'en',
resources: {
en: {
translation: {
'Greeting': 'Hello, {{name}}.',
},
},
},
});
interface TransDataMap {
'Greeting': { name: string; };
}
function intl
<K extends keyof TransDataMap>
(children: K, data: TransDataMap[K], factory?: El.Factory<HTMLElementTagNameMap, El.Children.Void>)
: El.Factory<HTMLElementTagNameMap, El.Children.Void> {
return (html, tag) => {
const el = factory?.(html, tag, {}) ?? html(tag);
translator.init((err, t) =>
el.textContent = err
? '{% Failed to initialize the translator. %}'
: t(children, data) ?? `{% Failed to translate "${children}". %}`);
return el;
};
}
const el = HTML.span(intl('Greeting', { name: 'world' }));
assert(el.children === undefined);
assert(el.element.textContent === 'Hello, world.');
Or
function data
<K extends keyof TransDataMap>
(data: TransDataMap[K], factory?: El.Factory<HTMLElementTagNameMap, K>)
: El.Factory<HTMLElementTagNameMap, K> {
return (html, tag, _, children) =>
define(factory?.(html, tag, {}, children) ?? html(tag), {
onmutate: ev =>
void translator.init((err, t) =>
ev.currentTarget.textContent = err
? '{% Failed to initialize the translator. %}'
: t(children, data) ?? `{% Failed to translate "${children}". %}`),
});
}
const el = HTML.span('Greeting', data({ name: 'world' }));
assert(el.children === 'Hello, world.');
assert(el.element.textContent === 'Hello, world.');
Create an HTML element proxy.
import { HTML, frag } from 'typed-dom';
HTML.p();
HTML.p('text');
HTML.p(frag(['a', html('br'), 'b']));
HTML.p([HTML.a()]);
HTML.p({ link: HTML.a() }]);
HTML.p({ id: 'id' });
HTML.p(() => document.createElement('p'));
HTML.p(() => document.querySelector('p')!);
HTML('p');
Create an SVG element proxy.
import { SVG } from 'typed-dom';
SVG.svg();
Create an MathML element proxy.
import { Math } from 'typed-dom';
Math.math();
Create an HTML element proxy assigning the children to the own open shadow DOM.
import { Shadow } from 'typed-dom';
Shadow.section();
All the APIs creating an element can be recreated as follows:
import { API, NS, shadow, element } from 'typed-dom';
const html = element<HTMLElementTagNameMap>(document, NS.HTML);
const svg = element<SVGElementTagNameMap>(document, NS.SVG);
const math = element<MathMLElementTagNameMap>(document, NS.Math);
const Shadow = API<ShadowHostHTMLElementTagNameMap>(html, shadow);
const HTML = API<HTMLElementTagNameMap>(html);
const SVG = API<SVGElementTagNameMap>(svg);
const Math = API<MathMLElementTagNameMap>(math);
A closed shadow DOM API can be created as follows:
const Shadow = API<ShadowHostHTMLElementTagNameMap>(html, el => shadow(el, { mode: 'closed' }));
Custom elements can be created by extending ShadowHostHTMLElementTagNameMap, HTMLElementTagNameMap, or SVGElementTagNameMap interface.
import { Shadow, HTML } from 'typed-dom';
declare global {
interface ShadowHostHTMLElementTagNameMap {
'custom-tag': HTMLElement;
}
interface HTMLElementTagNameMap {
'custom': HTMLElement;
}
}
window.customElements.define('custom-tag', class extends HTMLElement { });
Shadow('custom-tag').element.outerHTML; // '<custom-tag></custom-tag>'
HTML('custom-tag').element.outerHTML; // '<custom-tag></custom-tag>'
HTML.custom().element.outerHTML; // '<custom></custom>'
However, since scoped custom elements don't inherit global custom elements you shouldn't extend the built-in interfaces such as HTMLElementTagNameMap. Instead, you should create new interfaces and new APIs to define custom elements.
import { API, shadow, html } from 'typed-dom';
interface CustomShadowHostElementTagNameMap extends ShadowHostHTMLElementTagNameMap {
'custom-tag': HTMLElement;
}
interface CustomHTMLElementTagNameMap extends HTMLElementTagNameMap, CustomShadowHostElementTagNameMap {
'custom': HTMLElement;
}
export const Shadow = API<CustomShadowHostElementTagNameMap>(html, shadow);
export const HTML = API<CustomHTMLElementTagNameMap>(html);
Ideally, you should define custom elements only as scoped custom elements.
import { API, NS, shadow, html as h, element } from 'typed-dom';
interface ShadowHostScopedCustomHTMLElementTagNameMap extends ShadowHostHTMLElementTagNameMap {
'custom-tag': HTMLElement;
}
interface ScopedCustomHTMLElementTagNameMap extends HTMLElementTagNameMap, ShadowHostScopedCustomHTMLElementTagNameMap {
'custom': HTMLElement;
}
// Note that the following code is based on the unstandardized APIs of scoped custom elements.
const registry = new CustomElementRegistry();
// This Host function creates a proxy and makes its shadow DOM in the base document (light DOM).
export const Host = API<ShadowHostHTMLElementTagNameMap>(h, el =>
shadow(el, { mode: 'open', registry }));
// This html function creates a scoped custom element in a shadow DOM.
export const html = element<ScopedCustomHTMLElementTagNameMap>(
shadow('body', { mode: 'open', registry }),
NS.HTML);
// This HTML function creates a scoped custom element proxy in a shadow DOM.
export const HTML = API<ScopedCustomHTMLElementTagNameMap>(html);
// This Shadow function creates a scoped custom element proxy and makes its shadow DOM in a shadow DOM.
export const Shadow = API<ShadowHostScopedCustomHTMLElementTagNameMap>(html, shadow);
These events are enabled only when an event listener is set using the Typed-DOM APIs.
The mutate event is dispatched when the children property value is changed.
The connect event is dispatched when added to another proxy connected to the context object.
The disconnect event is dispatched when removed from the parent proxy connected to the context object.
FAQs
A value-level and type-level DOM builder.
The npm package typed-dom receives a total of 8 weekly downloads. As such, typed-dom popularity was classified as not popular.
We found that typed-dom demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.