aberdeen 1.3.1 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aberdeen",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": "Frank van Viegen",
   "main": "dist-min/aberdeen.js",
   "devDependencies": {

package/src/aberdeen.ts

@@ -189,6 +189,19 @@ abstract class Scope implements QueueRunner {
 	// }
 }
 
+/**
+ * Execute a function once, after all currently scheduled jobs are completed.
+ */
+class DelayedOneTimeRunner implements QueueRunner {
+	prio: number = --lastPrio;
+	[ptr: ReverseSortedSetPointer]: this;
+	constructor(
+		public queueRun: () => void
+	) {
+		queue(this);
+	}
+}
+
 /**
  * All Scopes that can hold nodes and subscopes, including `SimpleScope` and `OnEachItemScope`
  * but *not* `OnEachScope`, are `ContentScope`s.
@@ -272,6 +285,8 @@ class ChainedScope extends ContentScope {
 			// If `currentScope` is not actually a ChainedScope, prevSibling will be undefined, as intended
 			this.prevSibling = currentScope.getChildPrevSibling();
 			currentScope.lastChild = this;
+		} else {
+			this.prevSibling = el.lastChild || undefined;
 		}
 
 		// We're always adding ourselve as a cleaner, in order to run our own cleaners
@@ -1688,6 +1703,26 @@ export const NO_COPY = Symbol("NO_COPY");
 // Promises break when proxied, so we'll just mark them as NO_COPY
 (Promise.prototype as any)[NO_COPY] = true;
 
+/**
+ * CSS variable lookup table for the `@` value prefix.
+ * 
+ * When a CSS value starts with `@`, the rest is used as a key to look up the actual value.
+ * Pre-initialized with keys '1'-'12' mapping to an exponential rem scale (e.g., @1=0.25rem, @3=1rem).
+ * 
+ * @example
+ * ```typescript
+ * cssVars.primary = '#3b82f6';
+ * cssVars[3] = '16px'; // Override @3 to be 16px instead of 1rem
+ * $('p color:@primary'); // Sets color to #3b82f6
+ * $('div mt:@3'); // Sets margin-top to 16px
+ * ```
+ */
+export const cssVars: Record<string, string> = optProxy({});
+
+for (let i = 1; i <= 12; i++) {
+	cssVars[i] = 2 ** (i - 3) + "rem";
+}
+
 /**
  * Clone an (optionally proxied) object or array.
  *
@@ -1806,8 +1841,10 @@ function applyBind(el: HTMLInputElement, target: any) {
 		onProxyChange = () => {
 			el.value = target.value;
 			// biome-ignore lint/suspicious/noDoubleEquals: it's fine for numbers to be casts to strings here
-			if (el.tagName === "SELECT" && el.value != target.value)
-				throw new Error(`SELECT has no '${target.value}' OPTION (yet)`);
+			if (el.tagName === "SELECT" && el.value != target.value) {
+				// Presumable, OPTIONs haven't been created yet. Try again after all currently queued work has been done.
+				new DelayedOneTimeRunner(() => el.value = target.value);
+			}
 		};
 	}
 	derive(onProxyChange);
@@ -2047,7 +2084,7 @@ function findFirst(str: string, chars: string, startPos: number): number {
 let cssCount = 0;
 
 /**
- * Inserts CSS rules into the document, optionally scoping them with a unique class name.
+ * Inserts CSS rules into the document, scoping them with a unique class name.
  *
  * Takes a JavaScript object representation of CSS rules. camelCased property keys are
  * converted to kebab-case (e.g., `fontSize` becomes `font-size`).
@@ -2058,11 +2095,9 @@ let cssCount = 0;
  *   - In case a selector contains a `&`, that character will be replaced by the parent selector.
  *   - Selectors will be split on `,` characters, each combining with the parent selector with *or* semantics.
  *   - Selector starting with `'@'` define at-rules like media queries. They may be nested within regular selectors.
- * @param global - If `true`, styles are inserted globally without prefixing.
- *                 If `false` (default), all selectors are prefixed with a unique generated
- *                 class name (e.g., `.AbdStl1`) to scope the styles.
- * @returns The unique class name prefix used for scoping (e.g., `.AbdStl1`), or an empty string
- *          if `global` was `true`. Use this prefix with {@link $} to apply the styles.
+ * @param global - @deprecated Use {@link insertGlobalCss} instead.
+ * @returns The unique class name prefix used for scoping (e.g., `.AbdStl1`). Use this 
+ *          prefix with {@link $} to apply the styles.
  *
  * @example Scoped Styles
  * ```typescript
@@ -2087,29 +2122,61 @@ let cssCount = 0;
  *   $('div.child-element#Child'); // .AbdStl1 .child-element rule applies
  * });
  * ```
- *
+ */
+export function insertCss(style: object, global = false): string {
+	const prefix = global ? "" : `.AbdStl${++cssCount}`;
+	const css = styleToCss(style, prefix);
+	if (css) $(`style#${css}`);
+	return prefix;
+}
+
+/**
+ * Inserts CSS rules globally.
+ * 
+ * Works exactly like {@link insertCss}, but without prefixing selectors with a unique class name.
+ * 
  * @example Global Styles
  * ```typescript
- * insertCss({
+ * insertGlobalCss({
  *   '*': {
  *     fontFamily: 'monospace',
+ *     m: 0, // Using shortcut for margin
  *   },
  *   'a': {
  *     textDecoration: 'none',
- *     color: "#107ab0",
+ *     fg: "@primary", // Using foreground shortcut and CSS variable
  *   }
- * }, true); // Pass true for global
+ * });
  *
  * $('a#Styled link');
  * ```
  */
-export function insertCss(style: object, global = false): string {
-	const prefix = global ? "" : `.AbdStl${++cssCount}`;
-	const css = styleToCss(style, prefix);
-	if (css) $(`style#${css}`);
-	return prefix;
+export function insertGlobalCss(style: object): string {
+	return insertCss(style, true);
 }
 
+const CSS_SHORT: Record<string, string | string[]> = {
+	m: "margin",
+	mt: "marginTop",
+	mb: "marginBottom",
+	ml: "marginLeft",
+	mr: "marginRight",
+	mh: ["marginLeft", "marginRight"],
+	mv: ["marginTop", "marginBottom"],
+	p: "padding",
+	pt: "paddingTop",
+	pb: "paddingBottom",
+	pl: "paddingLeft",
+	pr: "paddingRight",
+	ph: ["paddingLeft", "paddingRight"],
+	pv: ["paddingTop", "paddingBottom"],
+	w: "width",
+	h: "height",
+	bg: "background",
+	fg: "color",
+	r: "borderRadius",
+};
+
 function styleToCss(style: object, prefix: string): string {
 	let props = "";
 	let rules = "";
@@ -2127,7 +2194,11 @@ function styleToCss(style: object, prefix: string): string {
 					);
 				}
 			} else {
-				props += `${k.replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`)}:${v};`;
+				const val = v == null || v === false ? "" : typeof v === 'string' ? (v[0] === '@' ? (cssVars as any)[v.substring(1)] || "" : v) : String(v);
+				const expanded = CSS_SHORT[k] || k;
+				for (const prop of (Array.isArray(expanded) ? expanded : [expanded])) {
+					props += `${prop.replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`)}:${val};`;
+				}
 			}
 		}
 	}
@@ -2150,10 +2221,15 @@ function applyArg(el: Element, key: string, value: any) {
 		if (value) el.classList.add(...classes);
 		else el.classList.remove(...classes);
 	} else if (key[0] === "$") {
-		// Style
-		const name = key.substring(1);
-		if (value == null || value === false) (el as any).style[name] = "";
-		else (el as any).style[name] = `${value}`;
+		// Style (with shortcuts)
+		key = key.substring(1);
+		const val = value == null || value === false ? "" : typeof value === 'string' ? (value[0] === '@' ? (cssVars as any)[value.substring(1)] || "" : value) : String(value);
+		const expanded = CSS_SHORT[key] || key;
+		if (typeof expanded === "string") {
+			(el as any).style[expanded] = val;
+		} else {
+			for (const prop of expanded) (el as any).style[prop] = val;
+		}
 	} else if (value == null) {
 		// Value left empty
 		// Do nothing

package/README.md.bak

@@ -1,212 +0,0 @@
-# [Aberdeen](https://aberdeenjs.org/) [![](https://img.shields.io/badge/license-ISC-blue.svg)](https://github.com/vanviegen/aberdeen/blob/master/LICENSE.txt) [![](https://badge.fury.io/js/aberdeen.svg)](https://badge.fury.io/js/aberdeen) ![](https://img.shields.io/bundlejs/size/aberdeen) [![](https://img.shields.io/github/last-commit/vanviegen/aberdeen)](https://github.com/vanviegen/aberdeen)
-
-Build fast reactive UIs in pure TypeScript/JavaScript without a virtual DOM.
-
-Aberdeen's approach is refreshingly simple:
-
-> Use many small anonymous functions for emitting DOM elements, and automatically rerun them when their underlying data changes. JavaScript `Proxy` is used to track reads and updates to this data, which can consist of anything, from simple values to complex, typed, and deeply nested data structures. 
-
-## Why use Aberdeen?
-
-- 🎩 **Simple:** Express UIs naturally in JavaScript/TypeScript, without build steps or JSX, and with a minimal amount of concepts you need to learn.
-- ⏩ **Fast:** No virtual DOM. Aberdeen intelligently updates only the minimal, necessary parts of your UI when proxied data changes.
-- 👥 **Awesome lists**: It's very easy and performant to reactively display data sorted by whatever you like.
-- 🔬 **Tiny:** Around 6KB (minimized and gzipped) for the core system. Zero runtime dependencies.
-- 🔋 **Batteries included**: Comes with browser history management, routing, revertible patches for optimistic user-interface updates, component-local CSS, SVG support, helper functions for transforming reactive data (mapping, partitioning, filtering, etc) and hide/unhide transition effects. No bikeshedding required!
-
-## Why *not* use Aberdeen?
-
-- 🤷 **Lack of community:** There are not many of us -Aberdeen developers- yet, so don't expect terribly helpful Stack Overflow/AI answers.
-- 📚 **Lack of ecosystem:** You'd have to code things yourself, instead of duct-taping together a gazillion React ecosystem libraries.
-
-## Examples
-
-First, let's start with the obligatory reactive counter example. If you're reading this on [the official website](https://aberdeenjs.org) you should see a working demo below the code, and an 'edit' button in the top-right corner of the code, to play around.
-
-```javascript
-import A from 'aberdeen';
-
-// Define some state as a proxied (observable) object
-const state = A.proxy({question: "How many roads must a man walk down?", answer: 42});
-
-A`h3`(() => {
-    // This function reruns whenever the question or the answer changes
-    A`"${state.question} ↪ ${state.answer || 'Blowing in the wind'}"`;
-});
-
-// Two-way bind state.question to an <input>
-A`input placeholder=Question bind!${A.at(state, 'question')}`;
-
-// Allow state.answer to be modified using both an <input> and buttons
-A`div.row`(() => {
-    A`button click=${() => state.answer--} "-"`;
-    A`input type=number bind!${A.at(state, 'answer')}`;
-    A`button click=${() => state.answer++} "+"`;
-});
-```
-
-Okay, next up is a somewhat more complex app - a todo-list with the following behavior:
-
-- New items open in an 'editing state'.
-- Items that are in 'editing state' show a text input, a save button and a cancel button. Done status cannot be toggled while editing.
-- Pressing one of the buttons, or pressing enter will transition from 'editing state' to 'viewing state', saving the new label text unless cancel was pressed.
-- In 'viewing state', the label is shown as non-editable. There's an 'Edit' link, that will transition the item to 'editing state'. Clicking anywhere else will toggle the done status.
-- The list of items is sorted alphabetically by label. Items move when 'save' changes their label.
-- Items that are created, moved or deleted grow and shrink as appropriate.
-
-Pfew.. now let's look at the code:
-
-```typescript
-import A from "aberdeen";
-import {grow, shrink} from "aberdeen/transitions";
-
-// We'll use a simple class to store our data.
-class TodoItem {
-    constructor(public label: string = '', public done: boolean = false) {}
-    toggle() { this.done = !this.done; }
-}
-
-// The top-level user interface.
-function drawMain() {
-    // Add some initial items. We'll wrap a proxy() around it!
-    let items: TodoItem[] = A.proxy([
-        new TodoItem('Make todo-list demo', true),
-        new TodoItem('Learn Aberdeen', false),
-    ]);
-    
-    // Draw the list, ordered by label.
-    A.onEach(items, drawItem, item => item.label);
-
-    // Add item and delete checked buttons.
-    A`div.row`(() => {
-        A`button click=${() => items.push(new TodoItem(""))} "+"`;
-        A`button.outline click=${() => {
-            for(let idx in items) {
-                if (items[idx].done) delete items[idx];
-            }
-        }} "Delete checked"`;
-    });
-};
-
-// Called for each todo list item.
-function drawItem(item) {
-    // Items without a label open in editing state.
-    // Note that we're creating this proxy outside the `div.row` scope
-    // create below, so that it will persist when that state reruns.
-    let editing: {value: boolean} = A.proxy(item.label == '');
-
-    A`div.row.${todoItemStyle} create!${grow} destroy!${shrink}`(() => {
-        // Conditionally add a class to `div.row`, based on item.done
-        A`if!${A.at(item,'done')} .done`;
-
-        // The checkmark is hidden using CSS
-        A`div.checkmark "✅"`;
-
-        if (editing.value) {
-            // Label <input>. Save using enter or button.
-            function save() {
-                editing.value = false;
-                item.label = inputElement.value;
-            }
-            let inputElement = A`input placeholder=Label value~${item.label} keydown=${e => e.key==='Enter' && save()}`;
-            A`button.outline click=${() => editing.value = false} "Cancel"`;
-            A`button click=${save} "Save"`;
-        } else {
-            // Label as text. 
-            A`p "${item.label}"`;
-
-            // Edit icon, if not done.
-            if (!item.done) {
-                A`a click=${e => {
-                    editing.value = true;
-                    e.stopPropagation(); // We don't want to toggle as well.
-                }} "Edit"`;
-            }
-            
-            // Clicking a row toggles done.
-            A`click=${() => item.done = !item.done} cursor:pointer`;
-        }
-    });
-}
-
-// Insert some component-local CSS, specific for this demo.
-const todoItemStyle = A.insertCss({
-    marginBottom: "0.5rem",
-    ".checkmark": {
-        opacity: 0.2,
-    },
-    "&.done": {
-        textDecoration: "line-through",
-        ".checkmark": {
-            opacity: 1,
-        },
-    },
-});
-
-// Go!
-drawMain();
-```
-
-Some further examples:
-
-- [Input demo](https://aberdeenjs.org/examples/input/) - [Source](https://github.com/vanviegen/aberdeen/tree/master/examples/input)
-- [Tic Tac Toe demo](https://aberdeenjs.org/examples/tictactoe/) - [Source](https://github.com/vanviegen/aberdeen/tree/master/examples/tictactoe)
-- [List demo](https://aberdeenjs.org/examples/list/) - [Source](https://github.com/vanviegen/aberdeen/tree/master/examples/list)
-- [Routing demo](https://aberdeenjs.org/examples/router/) - [Source](https://github.com/vanviegen/aberdeen/tree/master/examples/router)
-- [JS Framework Benchmark demo](https://aberdeenjs.org/examples/js-framework-benchmark/) - [Source](https://github.com/vanviegen/aberdeen/tree/master/examples/js-framework-benchmark)
-
-## Learning Aberdeen
-
-- [Tutorial](https://aberdeenjs.org/Tutorial/)
-- [Reference documentation](https://aberdeenjs.org/modules.html)
-
-And you may want to study the examples above, of course!
-
-## Changelog
-
-### 1.2.0 (2025-09-27)
-
-**Enhancements:**
-- The `A` function now supports a concise template literal syntax for creating elements, setting attributes and properties, adding classes, etc. See the documentation for details.
-- The `A.proxy()` function can now accept `Promise`s, which will return an observable object with properties for `busy` status, `error` (if any), and the resolved `value`. This makes it easier to call async functions from within UI code.
-
-**Breaking changes:**
-- When a UI render function returns a `Promise`, that will now be reported as an error. Async render functions are fundamentally incompatible with Aberdeen's reactive model, so it's helpful to point that out. Use the new `A.proxy()` async support instead.
-- Setting attributes versus properties is no longer automatically inferred. Use `name=value` for attributes and `name~value` for properties.
-- Special attributes (like `bind`, `create`, `destroy`, `if`, `else`, `end`, and `html`) now use a different syntax: `name!value` or just `name!`.
-- Conditional rendering has been completely redesigned, now using `if!`, `else!`, and `end!` special attributes with different semantics.
-
-### 1.1.0 (2025-09-12)
-
-This major release aims to reduce surprises in our API, aligning more closely with regular JavaScript semantics (for better or worse).
-
-**Breaking changes:**
-
-- Functions that iterate objects (like `A.onEach` and `A.map`) will now only work on *own* properties of the object, ignoring those in the prototype chain. The new behavior should be more consistent and faster. 
-- These iteration function now properly distinguish between `undefined` and *empty*. Previously, object/array/map items with `undefined` values were considered non-existent. The new behavior (though arguably confusing) is more consistent with regular JavaScript semantics.
-- The `A.copy` function no longer ..
-    - Supports `SHALLOW` and `MERGE` flags. The latter has been replaced by a dedicated `A.merge` function. The former turned out not to be particularly useful.
-    - Has weird special cases that would allow copying objects into maps and merging objects into arrays.
-    - Copies properties from the prototype chain of objects. Only *own* properties are copied now. As the prototype link itself *is* copied over, this should actually result in copies being *more* similar to the original.
-- The `observe` function has been renamed to `A.derive` to better reflect its purpose and match terminology used in other reactive programming libraries.
-- The `A.route` API brings some significant changes. Modifying the `A.route` observable (which should now be accessed as `A.route.current`) will now always result in changing the current browser history item (URL and state, using `replaceState`), instead of using a heuristic to figure out what you probably want. Dedicated functions have been added for navigating to a new URL (`A.go`), back to a previous URL (`A.back`), and for going up in the route hierarchy (`A.up`). 
-- The concept of immediate observers (through the `immediateObserve` function) no longer exists. It caused unexpected behavior (for instance due to the fact that an array `pop()` in JavaScript is implemented as a delete followed by a length change, so happens in two steps that would each call immediate observers). The reason it existed was mostly to enable a pre-1.0 version of the `A.route` API. It turned out to be a mistake.
-
-**Enhancements:**
-
-- The `A.peek` function can now also accept an object and a key as argument (e.g. `A.peek(obj, 'myKey')`). It does the same as `A.peek(() => obj.myKey)`, but more concise and faster.
-- The `A.copy` and `A.merge` functions now ..
-    - Accept an optional `dstKey` argument, allowing you to assign to a specific key with `A.copy` semantics, and without subscribing to the key.
-    - Return a boolean indicating whether any changes were made.
-    - Are faster.
-- A new `A.dispatcher` module has been added. It provides a simple and type-safe way to match URL paths to handler functions, and extract parameters from the path. You can still use your own routing solution if you prefer, of course.
-- The `A.route` module now also has tests, making the whole project now fully covered by tests.
-
-**Fixes:**
-
-- Browser-back behavior in the `A.route` module had some reliability issues after page reloads.
-- The `A.copy` and `A.clone` function created Maps and Arrays with the wrong internal type. So `instanceof Array` would say yes, while `Array.isArray` would say no. JavaScript is weird.
-
-### 1.0.0 (2025-05-07)
-
-After five years of working on this library on and off, I'm finally happy with its API and the developer experience it offers. I'm calling it 1.0! To celebrate, I've created some pretty fancy (if I may say so myself) interactive documentation and a tutorial.