@react5/dom-jsx 0.1.5 → 0.1.7

package/README.md

@@ -24,31 +24,31 @@ The runtime also works with Vite. Vite discovers the package's ESM `jsx-runtime`
 Function components may return DOM nodes with an attached API:
 
 ```tsx
-type ModalContext = { open(): void; close(): void }
+type ModalApi = { open(): void; close(): void }
 
 function Modal() {
   const element = <dialog /> as HTMLDialogElement
-  const context: ModalContext = {
+  const api: ModalApi = {
     open: () => element.showModal(),
     close: () => element.close()
   }
 
-  return Object.assign(element, { context }) satisfies
-    HTMLDialogElement & { context: ModalContext }
+  return Object.assign(element, { api }) satisfies
+    HTMLDialogElement & { api: ModalApi }
 }
 
 const modal = <Modal />
-modal.context?.open()
+modal.api?.open()
 ```
 
 TypeScript represents all JSX expressions with one `JSX.Element` type, so it
 cannot preserve the exact intersection type of an individual component in
-TSX. The library's JSX element type therefore allows an optional `context`
+TSX. The library's JSX element type therefore allows an optional `api`
 property, typed loosely as `Record<string, any>`, on every JSX result.
 Accessing any other property directly on the node (e.g. a typo'd DOM
-property) is still checked normally. `context` is optional because plain
+property) is still checked normally. `api` is optional because plain
 intrinsic elements don't have one, so calling through it via `<Tag />` JSX
-syntax needs `?.`. To get the component's exact, non-optional `context`
+syntax needs `?.`. To get the component's exact, non-optional `api`
 type instead, call the component directly or call `jsx(Modal, null)` /
 `jsxDEV(Modal, null)`.
 
@@ -59,7 +59,7 @@ Intrinsic JSX tags become DOM elements. `class` sets `className`, `style` accept
 The public entry points are:
 
 ```ts
-import { createRef, jsx, jsxs, Fragment } from '@react5/dom-jsx'
+import { createRef, createContext, useContext, onCleanup, onDispose, dispose, jsx, jsxs, Fragment } from '@react5/dom-jsx'
 import { jsx, jsxs, jsxDEV, Fragment } from '@react5/dom-jsx/jsx-dev-runtime'
 ```
 
@@ -84,6 +84,84 @@ inputRef.current // HTMLInputElement
 
 A callback ref (`ref={(el) => ...}`) is also supported and is invoked with the element once it's created.
 
+### Context
+
+Pass values down to nested components without threading props through every level:
+
+```tsx
+import { createContext, useContext } from '@react5/dom-jsx'
+
+const ThemeContext = createContext({ color: 'black' })
+
+function Title(props: { text: string }) {
+  const theme = useContext(ThemeContext)
+  return <h1 style={{ color: theme.color }}>{props.text}</h1>
+}
+
+const page = (
+  <ThemeContext.Provider value={{ color: 'red' }}>
+    {() => <Title text="Hello" />}
+  </ThemeContext.Provider>
+)
+```
+
+JSX in this runtime is evaluated eagerly from the inside out: children are
+created before their parent component runs. A Provider's child must
+therefore be a render function (`{() => ...}`); the Provider calls it while
+its value is active, so every component rendered inside sees that value.
+Providers can be nested, and the innermost value wins.
+
+`useContext` returns the nearest Provider's value only while rendering is in
+progress. Call it synchronously in a component body and keep the result.
+Called later, for example from an event handler or a `setTimeout`, it
+returns the context's default value.
+
+### Cleanup
+
+Release subscriptions, timers, and other resources when content is discarded.
+Register cleanups with `onCleanup` in a component body, or with
+`onDispose(node, fn)` anywhere else:
+
+```tsx
+import { dispose, onCleanup, onDispose } from '@react5/dom-jsx'
+
+function Clock() {
+  const el = <time /> as HTMLTimeElement
+  const id = setInterval(() => { el.textContent = new Date().toLocaleTimeString() }, 1000)
+  onCleanup(() => clearInterval(id))
+  return el
+}
+
+const node = <Clock />
+onDispose(node, () => console.log('disposed'))
+
+// Later, where content is swapped:
+old.replaceWith(next)
+dispose(old)
+```
+
+The DOM gives no synchronous signal when a node is removed, so `dispose` must
+be called explicitly. It runs the cleanups of the node and of every node inside
+it, descendants first, each node's cleanups in reverse registration order.
+Disposal follows the DOM tree, so components passed as children are covered
+even though they render before their parent. Each cleanup runs at most once;
+if some throw, the rest still run and the error (or an `AggregateError`) is
+rethrown afterwards.
+
+A component's cleanups are attached to the node it returns. When it returns a
+fragment, they are attached to the fragment's top-level children and run once
+all of them are disposed, so dispose every one of them, or a common ancestor.
+An empty fragment gets an empty comment node to carry its cleanups.
+
+If a component throws while rendering, the cleanups it already registered run
+immediately. So do those of components it rendered and of JSX passed to it in
+props, unless those nodes are already in the document.
+
+`onCleanup` throws when called outside a component render, e.g. from an event
+handler or after an `await`; use `onDispose(node, fn)` there. Moving a node
+never disposes it. A node that is discarded without `dispose` keeps its
+cleanups until it is garbage-collected, and they never run.
+
 ## Development
 
 ```sh

package/dist/index.js

@@ -1 +1 @@
-import{Fragment as r,createRef as m,jsx as o,jsxs as t}from"./jsx-runtime.js";export{r as Fragment,m as createRef,o as jsx,t as jsxs};
+import{Fragment as r,createContext as m,createRef as o,dispose as t,jsx as e,jsxs as i,onCleanup as j,onDispose as p,useContext as s}from"./jsx-runtime.js";export{r as Fragment,m as createContext,o as createRef,t as dispose,e as jsx,i as jsxs,j as onCleanup,p as onDispose,s as useContext};

package/dist/jsx-runtime.d.ts

@@ -25,15 +25,27 @@ export type ElementProps<T extends HTMLElement> = Partial<Omit<T, 'children' | '
 export declare function createRef<T>(): {
     current: T | null;
 };
+export type ProviderProps<T> = {
+    value: T;
+    children: () => Child;
+};
+export type Context<T> = {
+    Provider: (props: ProviderProps<T>) => Node;
+};
+export declare function createContext<T>(defaultValue: T): Context<T>;
+export declare function useContext<T>(context: Context<T>): T;
+export declare function onDispose(node: Node, fn: () => void): void;
+export declare function onCleanup(fn: () => void): void;
+export declare function dispose(node: Node): void;
 export declare namespace JSX {
     type Element = Node & {
-        context?: Record<string, any>;
+        api?: Record<string, any>;
     };
     type IntrinsicElements = {
         [K in keyof HTMLElementTagNameMap]: ElementProps<HTMLElementTagNameMap[K]>;
     };
 }
-export declare function jsx<R extends Node>(tag: (props: any) => R, props: Props | null, _key?: string | number): R;
+export declare function jsx<P, R extends Node>(tag: (props: P) => R, props: {} extends P ? P | null : P, _key?: string | number): R;
 export declare function jsx(tag: string, props: Props | null, _key?: string | number): Node;
 export declare const jsxs: typeof jsx;
 export declare function Fragment(props: Props): DocumentFragment;

package/dist/jsx-runtime.js

@@ -1 +1 @@
-function e(){return{current:null}}function t(e,t,n){return function(e,t){const n=t??{};if("function"==typeof e)return e(n);const r=document.createElement(e);for(const[i,o]of Object.entries(n))if("children"!==i&&"ref"!==i)if(i.startsWith("on")&&"function"==typeof o)r.addEventListener(i.slice(2).toLowerCase(),o);else if("class"!==i){if("style"===i&&o&&"object"==typeof o)Object.assign(r.style,o);else if(null!=o)if(i.includes("-"))r.setAttribute(i,String(o));else{if(i in r){if(!1===o)continue;try{r[i]=o;continue}catch{}}r.setAttribute(i,!0===o?"":String(o))}}else r.className=String(o??"");i(r,n.children);const c=n.ref;"function"==typeof c?c(r):c&&(c.current=r);return r}(e,t)}var n=t;function r(e){const t=document.createDocumentFragment();return i(t,e.children),t}function i(e,t){if(Array.isArray(t))for(const n of t)i(e,n);else t instanceof Node?e.appendChild(t):null!=t&&!1!==t&&!0!==t&&e.appendChild(document.createTextNode(String(t)))}export{r as Fragment,e as createRef,t as jsx,n as jsxs};
+function e(){return{current:null}}var t=/* @__PURE__ */new WeakMap;function n(e){const n=[],o={Provider({value:e,children:t}){if("function"!=typeof t)throw new TypeError("Context Provider expects a single function child: {() => ...}");n.push(e);try{const e=t();if(e instanceof Node)return e;const n=document.createDocumentFragment();return m(n,e),n}finally{n.pop()}}};return t.set(o,{defaultValue:e,stack:n}),o}function o(e){const n=t.get(e);if(!n)throw new TypeError("useContext expects a context created by createContext");const{defaultValue:o,stack:r}=n;return r.length>0?r[r.length-1]:o}var r=/* @__PURE__ */new WeakMap,c=[];function s(e,t){const n=r.get(e);n?n.push(t):r.set(e,[t])}function i(e,t){s(e,()=>t())}function f(e){const t=c[c.length-1];if(!t)throw new Error("onCleanup must be called while a component is rendering; use onDispose(node, fn) instead");t.cleanups.push(e)}function u(e){const t=[];if(l(e,t),1===t.length)throw t[0];if(t.length>1)throw new AggregateError(t,"Multiple cleanups failed during dispose")}function l(e,t){for(const r of Array.from(e.childNodes))l(r,t);const n=r.get(e);if(n){r.delete(e);for(let e=n.length-1;e>=0;e--)try{n[e](t)}catch(o){t.push(o)}}}function a(e,t){for(let o=e.length-1;o>=0;o--)try{e[o]()}catch(n){t.push(n)}}function d(e,t){if(e instanceof Node)t.push(e);else if(Array.isArray(e))for(const n of e)d(n,t)}function p(e,t){const n={cleanups:[],rendered:[]};let o;c.push(n);try{o=e(t)}catch(f){throw c.pop(),function(e,t){const n=[],o=[...e.rendered];for(const r of Object.values(t))d(r,o);for(const r of o)r.isConnected||l(r,n);a(e.cleanups,n)}(n,t),f}c.pop();let r=[o];if(o instanceof DocumentFragment&&(!o.firstChild&&n.cleanups.length>0&&o.appendChild(document.createComment("")),r=Array.from(o.childNodes)),n.cleanups.length>0)if(1===r.length)for(const c of n.cleanups)i(r[0],c);else{let e=r.length;for(const t of r)s(t,t=>{0===--e&&a(n.cleanups,t)})}return c[c.length-1]?.rendered.push(...r),o}function h(e,t,n){return function(e,t){const n=t??{};if("function"==typeof e)return p(e,n);const o=document.createElement(e);for(const[c,s]of Object.entries(n))if("children"!==c&&"ref"!==c)if(c.startsWith("on")&&"function"==typeof s)o.addEventListener(c.slice(2).toLowerCase(),s);else if("class"!==c){if("style"===c&&s&&"object"==typeof s)Object.assign(o.style,s);else if(null!=s)if(c.includes("-"))o.setAttribute(c,String(s));else{if(c in o){if(!1===s)continue;try{o[c]=s;continue}catch{}}o.setAttribute(c,!0===s?"":String(s))}}else o.className=String(s??"");m(o,n.children);const r=n.ref;"function"==typeof r?r(o):r&&(r.current=o);return o}(e,t)}var g=h;function y(e){const t=document.createDocumentFragment();return m(t,e.children),t}function m(e,t){if(Array.isArray(t))for(const n of t)m(e,n);else t instanceof Node?e.appendChild(t):null!=t&&!1!==t&&!0!==t&&e.appendChild(document.createTextNode(String(t)))}export{y as Fragment,n as createContext,e as createRef,u as dispose,h as jsx,g as jsxs,f as onCleanup,i as onDispose,o as useContext};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react5/dom-jsx",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "JSX runtime for vanilla TS/JS projects.",
   "keywords": [
     "JSX"