Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beenotung/dom-proxy
Develop lightweight and declarative UI with automatic dependecy tracking without boilerplate code, VDOM, nor compiler
https://github.com/beenotung/dom-proxy
cdn dom lightweight proxy typescript-library
Last synced: about 1 month ago
JSON representation
Develop lightweight and declarative UI with automatic dependecy tracking without boilerplate code, VDOM, nor compiler
- Host: GitHub
- URL: https://github.com/beenotung/dom-proxy
- Owner: beenotung
- License: bsd-2-clause
- Created: 2023-03-05T05:48:10.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-08T06:40:35.000Z (about 1 year ago)
- Last Synced: 2024-12-09T05:42:05.482Z (about 2 months ago)
- Topics: cdn, dom, lightweight, proxy, typescript-library
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/dom-proxy
- Size: 124 KB
- Stars: 28
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dom-proxy
Develop lightweight and declarative UI with automatic dependency tracking in Javascript/Typescript without boilerplate code, VDOM, nor compiler.
[](https://www.npmjs.com/package/dom-proxy)
[](https://bundlephobia.com/package/dom-proxy)
[](https://bundlephobia.com/package/dom-proxy)
Demo: https://dom-proxy.surge.sh
## Table of Content
- [Quick Example](#quick-example)
- [Installation](#installation)
- [How it works](#how-it-works)
- [Usage Examples](#usage-examples)
- [Example using creation functions](#example-using-creation-functions)
- [Example using selector functions](#example-using-selector-functions)
- [Typescript Signature](#typescript-signature)
- [Reactive function](#reactive-function)
- [Selector functions](#selector-functions)
- [Creation functions](#creation-functions)
- [Creation helper functions](#creation-helper-functions)
- [Partially applied creation functions](#partially-applied-creation-functions)
- [Options Types / Output Types](#options-types--output-types)
- [FOSS License](#license)
## Quick Example
```javascript
// elements type are inferred from selector
let { password, showPw } = queryElementProxies({
showPw: 'input#show-pw',
password: '[name=password]',
})
watch(() => {
password.type = showPw.checked ? 'text' : 'password'
})
// create new element or text node, then proxy on it
let nameInput = input({ placeholder: 'guest', id: 'visitor-name' })
let nameText = text()
// auto re-run when the value in changed
watch(() => {
nameText.textContent = nameInput.value || nameInput.placeholder
})
document.body.appendChild(
fragment([
label({ textContent: 'name: ', htmlFor: nameInput.id }),
nameInput,
p(['hello, ', nameText]),
]),
)
```
Complete example see [quick-example.ts](./demo/quick-example.ts)
(Explained in the [usage examples](#usage-examples) section)
## Installation
You can get dom-proxy via npm:
```bash
npm install dom-proxy
```
Then import from typescript using named import or star import:
```typescript
import { watch } from 'dom-proxy'
import * as domProxy from 'dom-proxy'
```
Or import from javascript as commonjs module:
```javascript
var domProxy = require('dom-proxy')
```
You can also get dom-proxy directly in html via CDN:
```html
console.log(typeof domProxy.watch) // function
```
## How it works
A DOM proxy can be used to enable reactive programming by intercepting access to a DOM node's properties and triggering updates to the UI whenever those properties are changed.
Here's an example of how a DOM proxy can be used to enable reactive programming:
```javascript
const nameInput = document.querySelector('input#name')
const message = document.querySelector('p#message')
const inputProxy = new Proxy(nameInput, {
set(target, property, value) {
target[property] = value
message.textContent = 'Hello, ' + value + '!'
return true
},
})
inputProxy.value = 'world'
```
In this example, we've created a reactive input element by creating a DOM proxy for the input element. The set trap of the proxy is used to intercept any changes made to the input's value, and it updates the output element's text content to reflect the new value.
However, it is quite verbose to work with the Proxy API directly.
`dom-proxy` allows you to do reactive programming concisely. With `dom-proxy`, above example can be written as:
```javascript
let { nameInput, message } = queryElementProxies({
nameInput: 'input#name',
message: 'p#message',
})
watch(() => {
message.textContent = 'Hello, ' + nameInput.value + '!'
})
nameInput.value = 'world'
```
In above example, the `textContent` of `message` depends on the `value` of `nameInput`, this dependency is automatically tracked without explicitly coding.
This is in contrast to `useEffect()` in `React` where you have to manually maintain the dependency list. Also, `dom-proxy` works in mutable manner, hence we don't need to run "diffing" algorithm on VDOM to reconciliate the UI.
## Usage Examples
More examples can be found in [./demo](./demo):
- [index.ts](./demo/index.ts)
- [signup.ts](./demo/signup.ts)
- [hybrid.html](./demo/hybrid.html) + [hybrid.ts](./demo/hybrid.ts)
- [style.html](./demo/style.html) + [style.ts](./demo/style.ts)
### Example using creation functions
This example consists of a input and text message.
With the `watch()` function, the text message is initialized and updated according to the input value. We don't need to specify the dependency explicitly.
```typescript
import { watch, input, span, label, fragment } from 'dom-proxy'
let nameInput = input({ placeholder: 'guest', id: 'visitor-name' })
let nameSpan = span()
// the read-dependencies are tracked automatically
watch(() => {
nameSpan.textContent = nameInput.value || nameInput.placeholder
})
document.body.appendChild(
// use a DocumentFragment to contain the elements
fragment([
label({ textContent: 'name: ', htmlFor: nameInput.id }),
nameInput,
p(['hello, ', nameSpan]),
]),
)
```
### Example using selector functions
This example query and proxy the existing elements from the DOM, then setup interactive logics in the `watch()` function.
If the selectors don't match any element, it will throw error.
```typescript
import { ProxyNode, watch } from 'dom-proxy'
import { queryElement, queryElementProxies } from 'dom-proxy'
let loginForm = queryElement('form#loginForm') // infer to be HTMLFormElement
let { password, showPw } = queryElementProxies(
{
showPw: 'input#show-pw', // infer to be ProxyNode <- "input" tagName
password: '[name=password]', // fallback to be ProxyNode <- "[name=.*]" attribute without tagName
},
loginForm,
)
watch(() => {
password.type = showPw.checked ? 'text' : 'password'
})
```
## Typescript Signature
The types shown in this section are simplified, see the `.d.ts` files published in the npm package for complete types.
### Reactive function
```typescript
/** @description run once immediately, auto track dependency and re-run */
function watch(
fn: Function,
options?: {
listen?: 'change' | 'input' // default 'input'
},
): void
```
### Selector functions
These query selector functions (except `queryAll*()`) will throw error if no elements match the selectors.
The corresponding element type is inferred from the tag name in the selector. (e.g. `select[name=theme]` will be inferred as `HTMLSelectElement`)
If the selector doesn't contain the tag name but containing "name" attribute (e.g. `[name=password]`), the inferred type will be `HTMLInputElement`.
If the element type cannot be determined, it will fallback to `Element` type.
```typescript
function queryElement(
selector: Selector,
parent?: ParentNode,
): InferElement
function queryElementProxy(
selector: Selector,
parent?: ParentNode,
): ProxyNode>
function queryAllElements(
selector: Selector,
parent?: ParentNode,
): InferElement[]
function queryAllElementProxies(
selector: Selector,
parent?: ParentNode,
): ProxyNode>[]
function queryElements>(
selectors: SelectorDict,
parent?: ParentNode,
): { [P in keyof SelectorDict]: InferElement }
function queryElementProxies>(
selectors: SelectorDict,
parent?: ParentNode,
): { [P in keyof SelectorDict]: ProxyNode> }
```
### Creation functions
```typescript
function fragment(nodes: NodeChild[]): DocumentFragment
/** @alias t, text */
function createText(value?: string | number): ProxyNode
/** @alias h, html */
function createHTMLElement(
tagName: K,
props?: Properties,
children?: NodeChild[],
): ProxyNode
/** @alias s, svg */
function createSVGElement(
tagName: K,
props?: Properties,
children?: NodeChild[],
): ProxyNode
function createProxy(node: Node): ProxyNode
```
### Creation helper functions
The creation function of most html elements and svg elements are defined as partially applied `createHTMLElement()` or `createSVGElement()`.
If you need more helper functions (e.g. for custom web components or deprecated elements[1]), you can defined them with `genCreateHTMLElement(tagName)` or `genCreateSVGElement(tagName)`
The type of creation functions are inferred from the tag name with `HTMLElementTagNameMap` and `SVGElementTagNameMap`.
Below are some example types:
```typescript
// some pre-defined creation helper functions
const div: PartialCreateElement,
p: PartialCreateElement,
a: PartialCreateElement,
label: PartialCreateElement,
input: PartialCreateElement,
path: PartialCreateElement,
polyline: PartialCreateElement,
rect: PartialCreateElement
// and more ...
```
For most elements, the creation functions use the same name as the tag name, however some are renamed to avoid name clash.
Renamed html element creation functions:
- `html` -> `htmlElement`
- `s` -> `sElement`
- `script` -> `scriptElement`
- `style` -> `styleElement`
- `title` -> `titleElement`
- `var` -> `varElement`
Renamed svg elements creation functions:
- `a` -> `aSVG`
- `script` -> `scriptSVG`
- `style` -> `styleSVG`
- `svg` -> `svgSVG`
- `switch` -> `switchSVG`
- `text` -> `textSVG`
- `title` -> `titleSVG`
Tips to rename the creation functions (click to expand)
The creation functions are defined dynamically in the proxy object `createHTMLElementFunctions` and `createSVGElementFunctions`
If you prefer to rename them with different naming conventions, you can destruct from the proxy object using your preferred name. For example:
```typescript
// you can destruct into custom alias from `createHTMLElementFunctions`
const { s, style, var: var_ } = createHTMLElementFunctions
// or destruct from `createSVGElementFunctions`
const { a, text } = createSVGElementFunctions
// or destruct from createElementFunctions, which wraps above two objects as `html` and `svg`
const {
html: { a: html_a, style: htmlStyle },
svg: { a: svg_a, style: svgStyle },
} = createElementFunctions
```
You can also use them without renaming, e.g.:
```typescript
const h = createHTMLElementFunctions
let style = document.body.appendChild(
fragment([
// you can use the creation functions without extracting into top-level const
h.s({ textContent: 'Now on sales' }),
'Sold out',
]),
)
```
The types of the proxies are listed below:
```typescript
type CreateHTMLElementFunctions = {
[K in keyof HTMLElementTagNameMap]: PartialCreateElement<
HTMLElementTagNameMap[K]
>
}
const createHTMLElementFunctions: CreateHTMLElementFunctions
type CreateSVGElementFunctions = {
[K in keyof SVGElementTagNameMap]: PartialCreateElement<
SVGElementTagNameMap[K]
>
}
const createSVGElementFunctions: CreateSVGElementFunctions
const createElementFunctions: {
html: CreateHTMLElementFunctions
svg: CreateSVGElementFunctions
}
```
[1]: Some elements are deprecated in html5, e.g. dir, font, frame, frameset, marquee, param. They are not predefined to avoid tsc error in case their type definition are not included.
### Partially applied creation functions
These are some high-order functions that helps to generate type-safe creation functions for specific elements with statically typed properties.
```typescript
/** partially applied createHTMLElement */
function genCreateHTMLElement(
tagName: K,
): PartialCreateElement
/** partially applied createSVGElement */
function genCreateSVGElement(
tagName: K,
): PartialCreateElement
```
### Options Types / Output Types
```typescript
type ProxyNode = E & {
node: E
}
type NodeChild = Node | ProxyNode | string | number
type Properties = Partial<{
[P in keyof E]?: E[P] extends object ? Partial : E[P]
}>
interface PartialCreateElement {
(props?: Properties, children?: NodeChild[]): ProxyNode
(children?: NodeChild[]): ProxyNode
}
```
## License
This project is licensed with [BSD-2-Clause](./LICENSE)
This is free, libre, and open-source software. It comes down to four essential freedoms [[ref]](https://seirdy.one/2021/01/27/whatsapp-and-the-domestication-of-users.html#fnref:2):
- The freedom to run the program as you wish, for any purpose
- The freedom to study how the program works, and change it so it does your computing as you wish
- The freedom to redistribute copies so you can help others
- The freedom to distribute copies of your modified versions to others