Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/falsandtru/typed-dom
A value-level and type-level DOM builder.
https://github.com/falsandtru/typed-dom
css-in-js custom-elements shadow-dom styled-components web-components
Last synced: 6 days ago
JSON representation
A value-level and type-level DOM builder.
- Host: GitHub
- URL: https://github.com/falsandtru/typed-dom
- Owner: falsandtru
- License: apache-2.0
- Created: 2016-04-11T23:38:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T12:55:02.000Z (8 months ago)
- Last Synced: 2024-10-29T20:57:32.975Z (16 days ago)
- Topics: css-in-js, custom-elements, shadow-dom, styled-components, web-components
- Language: TypeScript
- Homepage:
- Size: 940 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.1
Awesome Lists containing this project
README
# typed-dom
*Professional programmers dislike being deprived of control and prefer to have complete control over everything. No magic needed. Only amateurs prefer magic.*
## Abstract
A value-level and type-level DOM builder.
**Visualize** DOM structures and **Assist** DOM access using static types.
```ts
const dom: El<"article", HTMLElement, {
style: El<"style", HTMLStyleElement, string>;
title: El<"h1", HTMLHeadingElement, string>;
content: El<"ul", HTMLUListElement, readonly El<"li", HTMLLIElement, string>[]>;
}>
```
## Concepts
- Statically type and visualize internal structures of DOM objects.
- Make wrapper APIs of built-in DOM APIs.
- Exclude complexity and blackboxing.
## Assurance
Problems of DOM manipulation arise when the expected DOM structure differs from the actual DOM structure. Typed-DOM assures by type that the expected DOM structure and the actual DOM structure match. Assured reliable DOM manipulation is all you need. Assurance by type is best, and assurance by template is wasteful and inflexible.
|Product|Approach|Problems|
|-|-|-|
|Typed-DOM|Type|-|
|jQuery|-|Breakable|
|React|Template|Wasteful, Inflexible|
## Difference
DOM manipulation must be easy and reliable, and 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|Problems|
|-|-|-|-|-|
|Typed-DOM|Type|Interface|API, Fork|Slow construction|
|jQuery|Query|Implementation|Plugin|Breakable, Implicit dependency|
|React|Create all and search difference|Implementation|Component|Breakable, Wasteful, Complex, Uncontrollable, Severely dependent, Incomplete vain reinvention of the browsers|
## Usage
Build a Typed-DOM component with styling.
```ts
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.
```ts
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;
set children(children: El.Setter);
}
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;
export type Setter =
C extends Children.Struct ? Partial :
C;
export type Factory<
M extends TagNameMap,
C extends El.Children = El.Children,
> =
(
baseFactory: BaseFactory,
tag: T,
attrs: Attrs>,
children: C,
) => M[T];
}
```
Using the static type, you can see the internal structure and can safely access to and manipulate it.
```ts
// Inspect
dom.element.outerHTML; // '.RANDOM { color: red; }
Title
- item
- item
dom.children.title.element.outerHTML; // '
Title
'dom.children.title.children; // 'Title'
dom.children.content.element.outerHTML; // '
- item
- item
dom.children.content.children[0].children; // 'item'
// Update
// - Text
dom.children.title.children = 'Text';
dom.children.title.element.outerHTML; // '
Text
'// - Array
dom.children.content.children = [
HTML.li('Array'),
];
dom.children.content.element.outerHTML; // '
- Array
// - Struct
dom.children = {
title: HTML.h1('Struct'),
};
dom.children.title.element.outerHTML; // '
Struct
'dom.children.title = HTML.h1('title');
dom.children.title.element.outerHTML; // '
title
'```
## Examples
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.
### DOM Components
Define composable DOM components.
```ts
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.
```ts
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).
```ts
import { Shadow, HTML, El } from 'typed-dom';
import { Coroutine } from 'spica/coroutine';
class Component extends Coroutine implements El {
constructor() {
super(async function* (this: Component) {
let count = 0;
this.text = count;
while (true) {
this.element.isConnected || await new Promise(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;
}
}
```
### i18n
Create a helper factory function for i18n.
However, client-side translation is inefficient except live updates due to the following increase in traffic data size.
- Schema of translation data.
- Logic of translation.
- Unused or duplicate data.
```ts
import { HTML, El, html, define } from 'typed-dom';
import i18next from 'i18next';
interface TransDataMap {
'Greeting': { name: string; };
}
const translator = i18next.createInstance({
lng: 'en',
resources: {
en: {
translation: {
'Greeting': 'Hello, {{name}}.',
},
},
} satisfies Record,
});
translator.init();
function intl
(text: K, data: TransDataMap[K], factory?: El.Factory)
: El.Factory {
return (html, tag) => {
const el = factory?.(html, tag, {}) ?? html(tag);
el.textContent = translator.t(text, data)
?? `{% Failed to translate "${text}". %}`;
return el;
};
}
const el = HTML.span(intl('Greeting', { name: 'world' }));
assert(el.children === undefined);
assert(el.element.textContent === 'Hello, world.');
```
Or
```ts
function data
(data: TransDataMap[K], factory?: El.Factory)
: El.Factory {
return (html, tag, _, children) =>
define(factory?.(html, tag, {}, children) ?? html(tag), {
onmutate: ev => {
ev.currentTarget.textContent = 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.');
```
## APIs
### HTML: { [tag]: (attrs?, children?, factory?) => El; (tag: string, ...): El; };
Create an HTML element proxy.
- attrs: Record
- children: undefined | string | El[] | Record | DocumentFragment
- factory: (html, tag, attrs, children) => HTMLElement
```ts
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');
```
### SVG: { [tag]: (attrs?, children?, factory?) => El; (tag: string, ...): El; };
Create an SVG element proxy.
- attrs: Record
- children: undefined | string | El[] | Record | DocumentFragment
- factory: (svg, tag, attrs, children) => SVGElement
```ts
import { SVG } from 'typed-dom';
SVG.svg();
```
### Math: { [tag]: (attrs?, children?, factory?) => El; (tag: string, ...): El; };
Create an MathML element proxy.
- attrs: Record
- children: undefined | string | El[] | Record | DocumentFragment
- factory: (svg, tag, attrs, children) => MathMLElement
```ts
import { Math } from 'typed-dom';
Math.math();
```
### Shadow: { [tag]: (attrs?, children?, factory?) => El; (tag: string, ...): El; };
Create an HTML element proxy assigning the children to the own open shadow DOM.
- attrs: Record
- children: undefined | string | El[] | Record | DocumentFragment
- factory: (html, tag, attrs, children) => HTMLElement
```ts
import { Shadow } from 'typed-dom';
Shadow.section();
```
### API
#### Create APIs
All the APIs creating an element can be recreated as follows:
```ts
import { API, NS, shadow, element } from 'typed-dom';
const html = element(document, NS.HTML);
const svg = element(document, NS.SVG);
const math = element(document, NS.Math);
const Shadow = API(html, shadow);
const HTML = API(html);
const SVG = API(svg);
const Math = API(math);
```
A closed shadow DOM API can be created as follows:
```ts
const Shadow = API(html, el => shadow(el, { mode: 'closed' }));
```
#### Extend APIs
Custom elements can be created by extending `ShadowHostHTMLElementTagNameMap`, `HTMLElementTagNameMap`, or `SVGElementTagNameMap` interface.
```ts
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; // ''
HTML('custom-tag').element.outerHTML; // ''
HTML.custom().element.outerHTML; // ''
```
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.
```ts
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(html, shadow);
export const HTML = API(html);
```
Ideally, you should define custom elements only as scoped custom elements.
```ts
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(h, el =>
shadow(el, { mode: 'open', registry }));
// This html function creates a scoped custom element in a shadow DOM.
export const html = element(
shadow('body', { mode: 'open', registry }),
NS.HTML);
// This HTML function creates a scoped custom element proxy in a shadow DOM.
export const HTML = API(html);
// This Shadow function creates a scoped custom element proxy and makes its shadow DOM in a shadow DOM.
export const Shadow = API(html, shadow);
```
### Others
- El
- NS
- Attrs
- Children
- Factory
- shadow
- frag
- html
- svg
- math
- text
- define
- append
- prepend
- defrag
- listen
- once
- delegate
- bind
- currentTarget
- querySelectorAll
- querySelectorWith
- querySelectorAllWith
- scope
## Events
These events are enabled only when an event listener is set using the Typed-DOM APIs.
### mutate
The mutate event is dispatched when the children property value is changed.
### connect
The connect event is dispatched when added to another proxy connected to the context object.
### disconnect
The disconnect event is dispatched when removed from the parent proxy connected to the context object.