Upload
This commit is contained in:
298
plugins/ui.js
298
plugins/ui.js
@@ -29,63 +29,142 @@ export const UI = ($, defaultLang = 'es') => {
|
||||
// --- UTILITY FUNCTIONS ---
|
||||
|
||||
/**
|
||||
* Conditional rendering component
|
||||
* @param {Function} condition - Signal function that returns boolean
|
||||
* @param {*} thenValue - Content to render when condition is true
|
||||
* @param {*} otherwiseValue - Content to render when condition is false
|
||||
* @returns {Function} Function that returns appropriate content based on condition
|
||||
* Normalized conditional rendering.
|
||||
* @param {Function} condition - Signal returning boolean.
|
||||
* @param {*} thenValue - Content if true.
|
||||
* @param {*} otherwiseValue - Content if false.
|
||||
* @returns {Function} Normalized accessor.
|
||||
*/
|
||||
ui._if = (condition, thenValue, otherwiseValue = null) => {
|
||||
return () => condition() ? thenValue : otherwiseValue;
|
||||
return () => {
|
||||
const isTrue = condition();
|
||||
const result = isTrue ? thenValue : otherwiseValue;
|
||||
if (typeof result === 'function' && !(result instanceof HTMLElement)) {
|
||||
return result();
|
||||
}
|
||||
return result;
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* List rendering component that efficiently updates when the source array changes
|
||||
* @param {Function} sourceSignal - Signal function that returns an array of items
|
||||
* @param {Function} renderCallback - Callback that renders each item (item, index) => DOM element
|
||||
* @returns {HTMLElement} Container element that holds the rendered list
|
||||
* FOR (List Rendering): Efficient keyed reconciliation with movement optimization.
|
||||
* @param {Function} source - Signal function returning an array of items.
|
||||
* @param {Function} render - (item, index) => HTMLElement.
|
||||
* @param {Function} keyFn - (item, index) => string|number. Required.
|
||||
* @returns {HTMLElement} Container with fragment-like behavior and automatic item cleanup.
|
||||
*/
|
||||
ui._for = (sourceSignal, renderCallback) => {
|
||||
const itemCache = new Map();
|
||||
const markerNode = document.createTextNode('');
|
||||
const container = $.html('div', { style: 'display:contents' }, [markerNode]);
|
||||
ui._for = (source, render, keyFn) => {
|
||||
if (typeof keyFn !== 'function') throw new Error('SigPro UI: _for requires a keyFn.');
|
||||
|
||||
const marker = document.createTextNode('');
|
||||
const container = $.html('div', { style: 'display:contents' }, [marker]);
|
||||
const cache = new Map();
|
||||
|
||||
$(() => {
|
||||
const items = sourceSignal() || [];
|
||||
const newCache = new Map();
|
||||
const parent = markerNode.parentNode;
|
||||
if (!parent) return;
|
||||
const items = source() || [];
|
||||
const newKeys = new Set();
|
||||
|
||||
items.forEach((item, index) => {
|
||||
if (itemCache.has(item)) {
|
||||
const cached = itemCache.get(item);
|
||||
newCache.set(item, cached);
|
||||
parent.insertBefore(cached.element, markerNode);
|
||||
itemCache.delete(item);
|
||||
const key = keyFn(item, index);
|
||||
newKeys.add(key);
|
||||
|
||||
if (cache.has(key)) {
|
||||
const runtime = cache.get(key);
|
||||
container.insertBefore(runtime.container, marker);
|
||||
} else {
|
||||
const element = $.html('div', { style: 'display:contents' }, [renderCallback(item, index)]);
|
||||
newCache.set(item, {
|
||||
element,
|
||||
cleanup: () => {
|
||||
if (element._cleanups) element._cleanups.forEach(cleanupFn => cleanupFn());
|
||||
}
|
||||
const runtime = $.createRuntime(() => {
|
||||
return $.html('div', { style: 'display:contents' }, [render(item, index)]);
|
||||
});
|
||||
parent.insertBefore(element, markerNode);
|
||||
cache.set(key, runtime);
|
||||
container.insertBefore(runtime.container, marker);
|
||||
}
|
||||
});
|
||||
|
||||
itemCache.forEach(cached => {
|
||||
if (cached.cleanup) cached.cleanup();
|
||||
cached.element.remove();
|
||||
cache.forEach((runtime, key) => {
|
||||
if (!newKeys.has(key)) {
|
||||
runtime.destroy();
|
||||
runtime.container.remove();
|
||||
cache.delete(key);
|
||||
}
|
||||
});
|
||||
|
||||
itemCache.clear();
|
||||
newCache.forEach((value, key) => itemCache.set(key, value));
|
||||
});
|
||||
|
||||
return container;
|
||||
};
|
||||
|
||||
/**
|
||||
* REQ (Request): Reactive fetch handler with auto-abort on re-executions or component destruction.
|
||||
* @param {string|Function} url - Target URL or Signal function returning a URL.
|
||||
* @param {Object} [payload] - Data to send in the body.
|
||||
* @param {Object} [options] - Fetch options including method, headers, and transform function.
|
||||
* @returns {{data: Function, loading: Function, error: Function, success: Function, reload: Function}}
|
||||
*/
|
||||
ui._req = (url, payload = null, options = {}) => {
|
||||
const data = $(null), loading = $(false), error = $(null), success = $(false);
|
||||
let abortController = null;
|
||||
|
||||
const execute = async (customPayload = null) => {
|
||||
const targetUrl = typeof url === 'function' ? url() : url;
|
||||
if (!targetUrl) return;
|
||||
|
||||
if (abortController) abortController.abort();
|
||||
abortController = new AbortController();
|
||||
|
||||
loading(true); error(null); success(false);
|
||||
try {
|
||||
const bodyData = customPayload || payload;
|
||||
const res = await fetch(targetUrl, {
|
||||
method: options.method || (bodyData ? 'POST' : 'GET'),
|
||||
headers: { 'Content-Type': 'application/json', ...options.headers },
|
||||
body: bodyData ? JSON.stringify(bodyData) : null,
|
||||
signal: abortController.signal,
|
||||
...options
|
||||
});
|
||||
|
||||
if (!res.ok) throw new Error(`HTTP ${res.status}`);
|
||||
|
||||
let json = await res.json();
|
||||
if (typeof options.transform === 'function') json = options.transform(json);
|
||||
|
||||
data(json);
|
||||
success(true);
|
||||
} catch (err) {
|
||||
if (err.name !== 'AbortError') error(err.message);
|
||||
} finally {
|
||||
loading(false);
|
||||
}
|
||||
};
|
||||
|
||||
$(() => {
|
||||
execute();
|
||||
return () => abortController?.abort();
|
||||
});
|
||||
|
||||
return { data, loading, error, success, reload: (p) => execute(p) };
|
||||
};
|
||||
|
||||
/**
|
||||
* RES (Resource/Response): UI handler for a Request object.
|
||||
* @param {Object} reqObj - The object returned by _req.
|
||||
* @param {Function} renderFn - (data) => HTMLElement. Executed only on success.
|
||||
* @returns {HTMLElement} A reactive container handling loading, error, and success states.
|
||||
*/
|
||||
ui._res = (reqObj, renderFn) => div({ class: 'res-container' }, [
|
||||
ui._if(reqObj.loading,
|
||||
div({ class: 'flex justify-center p-4' }, span({ class: 'loading loading-dots text-primary' }))
|
||||
),
|
||||
ui._if(reqObj.error, () =>
|
||||
div({ role: 'alert', class: 'alert alert-error' }, [
|
||||
span(reqObj.error()),
|
||||
ui._button({ class: 'btn-xs btn-ghost border-current', onclick: () => reqObj.reload() }, 'Retry')
|
||||
])
|
||||
),
|
||||
ui._if(reqObj.success, () => {
|
||||
const current = reqObj.data();
|
||||
return current !== null ? renderFn(current) : null;
|
||||
})
|
||||
]);
|
||||
|
||||
// --- INTERNAL HELPERS ---
|
||||
|
||||
/**
|
||||
@@ -94,9 +173,11 @@ export const UI = ($, defaultLang = 'es') => {
|
||||
* @param {string|Function} extraClasses - Additional classes or function returning classes
|
||||
* @returns {string|Function} Combined classes or function that returns combined classes
|
||||
*/
|
||||
const combineClasses = (baseClasses, extraClasses) => {
|
||||
if (typeof extraClasses === 'function') return () => `${baseClasses} ${extraClasses() || ''}`;
|
||||
return `${baseClasses} ${extraClasses || ''}`;
|
||||
const combineClasses = (base, extra) => {
|
||||
if (typeof extra === 'function') {
|
||||
return () => `${base} ${extra() || ''}`.trim();
|
||||
}
|
||||
return `${base} ${extra || ''}`.trim();
|
||||
};
|
||||
|
||||
// --- UI COMPONENTS ---
|
||||
@@ -175,19 +256,21 @@ export const UI = ($, defaultLang = 'es') => {
|
||||
]);
|
||||
|
||||
/**
|
||||
* Select dropdown component with reactive options and value binding
|
||||
* @param {Object} props - Select properties
|
||||
* @returns {HTMLElement} Select wrapper element
|
||||
* SELECT: Dropdown component with native SigPro $value binding and keyed options.
|
||||
* @param {Object} props - Select properties including $value signal and options array.
|
||||
* @returns {HTMLElement} Styled select element within a label wrapper.
|
||||
*/
|
||||
ui._select = (props) => label({ class: 'fieldset-label flex flex-col gap-1' }, [
|
||||
ui._if(() => props.label, span(props.label)),
|
||||
select({
|
||||
$.html('select', {
|
||||
...props,
|
||||
class: combineClasses('select select-bordered', props.$class || props.class),
|
||||
onchange: (event) => props.$value?.(event.target.value)
|
||||
}, ui._for(() => props.options || [], option =>
|
||||
$.html('option', { value: option.value, selected: option.value === props.$value?.() }, option.label))
|
||||
)
|
||||
$value: props.$value,
|
||||
onchange: (e) => props.$value?.(e.target.value)
|
||||
}, ui._for(() => props.options || [], opt =>
|
||||
$.html('option', { value: opt.value }, opt.label),
|
||||
opt => opt.value
|
||||
))
|
||||
]);
|
||||
|
||||
/**
|
||||
@@ -226,21 +309,36 @@ export const UI = ($, defaultLang = 'es') => {
|
||||
]);
|
||||
|
||||
/**
|
||||
* Modal dialog component with open state control
|
||||
* @param {Object} props - Modal properties
|
||||
* @param {*} children - Modal content
|
||||
* @returns {Function} Function that renders modal when open condition is true
|
||||
* MODAL: Dialog component with explicit runtime destruction via watcher.
|
||||
* @param {Object} props - Modal properties including $open signal and title.
|
||||
* @param {*} children - Inner modal content.
|
||||
* @returns {Function} Conditional modal renderer.
|
||||
*/
|
||||
ui._modal = (props, children) => ui._if(props.$open,
|
||||
dialog({ class: 'modal modal-open' }, [
|
||||
ui._modal = (props, children) => {
|
||||
let activeRuntime = null;
|
||||
|
||||
return ui._if(props.$open, () => {
|
||||
activeRuntime = $.createRuntime(() => dialog({
|
||||
class: 'modal modal-open'
|
||||
}, [
|
||||
div({ class: 'modal-box' }, [
|
||||
ui._if(() => props.title, h3({ class: 'text-lg font-bold mb-4' }, props.title)),
|
||||
children,
|
||||
div({ class: 'modal-action' }, ui._button({ onclick: () => props.$open(false) }, translate('close')))
|
||||
]),
|
||||
form({ method: 'dialog', class: 'modal-backdrop', onclick: () => props.$open(false) }, button(translate('close')))
|
||||
])
|
||||
);
|
||||
]));
|
||||
|
||||
const stopWatcher = $(() => {
|
||||
if (!props.$open()) {
|
||||
activeRuntime?.destroy();
|
||||
stopWatcher();
|
||||
}
|
||||
});
|
||||
|
||||
return activeRuntime.container;
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Generic Dropdown component for menus, pickers (color/date), or custom lists
|
||||
@@ -275,29 +373,32 @@ export const UI = ($, defaultLang = 'es') => {
|
||||
]);
|
||||
|
||||
/**
|
||||
* Tabs component with navigation and reactive content slots
|
||||
* @param {Object} props - Tabs properties
|
||||
* @param {Array} props.items - Array of tab objects { label, active: Signal/Fn, onclick: Fn, content: HTMLElement/Fn }
|
||||
* @param {string|Function} [props.$class] - Optional extra classes for the tab container
|
||||
* @returns {HTMLElement} Tabs container with navigation and content area
|
||||
* TABS: Navigation component with reactive items and content slots.
|
||||
* @param {Object} props - Tabs properties including items array or signal.
|
||||
* @returns {HTMLElement} Tabs container with navigation and content area.
|
||||
*/
|
||||
ui._tabs = (props) => div({ class: 'flex flex-col gap-4 w-full' }, [
|
||||
ui._tabs = (props) => {
|
||||
const itemsSignal = typeof props.items === 'function' ? props.items : () => props.items || [];
|
||||
|
||||
return div({ class: 'flex flex-col gap-4 w-full' }, [
|
||||
div({
|
||||
role: 'tablist',
|
||||
class: combineClasses('tabs tabs-lifted', props.$class || props.class)
|
||||
}, ui._for(() => props.items || [], tabItem => a({
|
||||
}, ui._for(itemsSignal, tabItem => a({
|
||||
role: 'tab',
|
||||
class: () => `tab ${(typeof tabItem.active === 'function' ? tabItem.active() : tabItem.active) ? 'tab-active' : ''}`,
|
||||
onclick: tabItem.onclick
|
||||
}, tabItem.label))
|
||||
),
|
||||
}, tabItem.label), t => t.label)),
|
||||
|
||||
div({ class: 'tab-content-area' }, () => {
|
||||
const activeItem = (props.items || []).find(it =>
|
||||
const activeItem = itemsSignal().find(it =>
|
||||
typeof it.active === 'function' ? it.active() : it.active
|
||||
);
|
||||
return activeItem ? (typeof activeItem.content === 'function' ? activeItem.content() : activeItem.content) : null;
|
||||
if (!activeItem) return null;
|
||||
return typeof activeItem.content === 'function' ? activeItem.content() : activeItem.content;
|
||||
})
|
||||
]);
|
||||
};
|
||||
|
||||
/**
|
||||
* Badge component for status indicators
|
||||
@@ -422,52 +523,41 @@ export const UI = ($, defaultLang = 'es') => {
|
||||
let toastContainer = null;
|
||||
|
||||
/**
|
||||
* Toast notification component that auto-dismisses after a duration
|
||||
* @param {string} message - The message to display
|
||||
* @param {string} type - Alert type (e.g., "alert-success", "alert-error")
|
||||
* @param {number} duration - Time in milliseconds before auto-dismiss
|
||||
* TOAST: Notification system with direct reference management and runtime cleanup.
|
||||
* @param {string} message - Text to display.
|
||||
* @param {string} [type] - daisyUI alert class.
|
||||
* @param {number} [duration] - Expiry time in ms.
|
||||
*/
|
||||
ui._toast = (message, type = "alert-success", duration = 3500) => {
|
||||
if (!toastContainer || !toastContainer.isConnected) {
|
||||
toastContainer = div({ class: "fixed top-0 right-0 z-[9999] p-4 flex flex-col gap-3 pointer-events-none items-end w-full max-w-sm" });
|
||||
document.body.appendChild(toastContainer);
|
||||
let container = document.getElementById('sigpro-toast-container');
|
||||
if (!container) {
|
||||
container = $.html('div', { id: 'sigpro-toast-container', class: 'fixed top-0 right-0 z-[9999] p-4 flex flex-col gap-2' });
|
||||
document.body.appendChild(container);
|
||||
}
|
||||
|
||||
const closeToast = (toastElement) => {
|
||||
if (!toastElement || toastElement._closing) return;
|
||||
toastElement._closing = true;
|
||||
toastElement.style.transform = "translateX(100%)";
|
||||
toastElement.style.opacity = "0";
|
||||
setTimeout(() => {
|
||||
toastElement.style.maxHeight = "0px";
|
||||
toastElement.style.marginBottom = "-0.75rem";
|
||||
toastElement.style.padding = "0px";
|
||||
}, 150);
|
||||
toastElement.addEventListener("transitionend", () => {
|
||||
toastElement.remove();
|
||||
if (toastContainer && !toastContainer.hasChildNodes()) {
|
||||
toastContainer.remove();
|
||||
toastContainer = null;
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
const toastElement = div({ class: "card bg-base-100 shadow-xl border border-base-200 w-full overflow-hidden transition-all duration-500 transform translate-x-full opacity-0 pointer-events-auto", style: "max-height: 200px;" }, [
|
||||
div({ class: "card-body p-1" }, [
|
||||
div({ role: "alert", class: `alert ${type} alert-soft border-none p-3 flex items-center justify-between gap-4` }, [
|
||||
span({ class: "font-medium text-sm" }, message),
|
||||
button({ class: "btn btn-ghost btn-xs btn-circle", onclick: (event) => closeToast(event.target.closest(".card")) }, [
|
||||
span({ class: "icon-[lucide--x] w-4 h-4" })
|
||||
])
|
||||
])
|
||||
])
|
||||
const runtime = $.createRuntime(() => {
|
||||
const el = div({ class: `alert ${type} shadow-lg transition-all duration-300 translate-x-10 opacity-0` }, [
|
||||
span(message),
|
||||
ui._button({ class: 'btn-xs btn-circle btn-ghost', onclick: () => remove() }, '✕')
|
||||
]);
|
||||
|
||||
toastContainer.appendChild(toastElement);
|
||||
requestAnimationFrame(() => requestAnimationFrame(() => toastElement.classList.remove("translate-x-full", "opacity-0")));
|
||||
setTimeout(() => closeToast(toastElement), duration);
|
||||
const remove = () => {
|
||||
el.classList.add('translate-x-full', 'opacity-0');
|
||||
setTimeout(() => {
|
||||
runtime.destroy();
|
||||
el.remove();
|
||||
if (!container.hasChildNodes()) container.remove();
|
||||
}, 300);
|
||||
};
|
||||
|
||||
setTimeout(remove, duration);
|
||||
return el;
|
||||
});
|
||||
|
||||
const toastEl = runtime.container.firstChild;
|
||||
container.appendChild(runtime.container);
|
||||
requestAnimationFrame(() => toastEl.classList.remove('translate-x-10', 'opacity-0'));
|
||||
};
|
||||
/**
|
||||
* Confirmation dialog component with cancel and confirm actions
|
||||
* @param {string} title - Dialog title
|
||||
|
||||
355
sigpro/llms.txt
Normal file
355
sigpro/llms.txt
Normal file
@@ -0,0 +1,355 @@
|
||||
```txt
|
||||
# SigPro Core – Complete Reference for AI
|
||||
|
||||
SigPro is a reactive UI library built on signals, with no virtual DOM and no compiler. It provides fine-grained reactivity, automatic cleanup, and direct DOM manipulation. This document describes the core API as exposed by the `$` global.
|
||||
|
||||
---
|
||||
|
||||
## The `$` Function
|
||||
|
||||
The `$` function creates **signals**, **computed values**, **effects**, and **persistent state**. Its behavior depends on the argument type.
|
||||
|
||||
### 1. Primitive Signal
|
||||
|
||||
```js
|
||||
const count = $(0); // create with initial value
|
||||
count(); // read → 0
|
||||
count(5); // write → 5
|
||||
count(v => v + 1); // update (increment)
|
||||
```
|
||||
|
||||
### 2. Reactive Object (Proxy)
|
||||
|
||||
If the argument is a plain object or array, a reactive proxy is returned. All properties become reactive, including nested objects.
|
||||
|
||||
```js
|
||||
const user = $({ name: 'Juan', age: 30 });
|
||||
user().name; // read property → 'Juan'
|
||||
user.name = 'Carlos'; // write property → triggers updates
|
||||
user.age = 31; // also reactive
|
||||
```
|
||||
|
||||
Nested objects are automatically wrapped in proxies when accessed.
|
||||
|
||||
### 3. Computed Signal
|
||||
|
||||
If the argument is a **function**, it creates a computed signal. The function is executed lazily and caches its result. Dependencies are automatically tracked.
|
||||
|
||||
```js
|
||||
const count = $(0);
|
||||
const double = $(() => count() * 2);
|
||||
double(); // → 0
|
||||
count(5);
|
||||
double(); // → 10 (automatically updated)
|
||||
```
|
||||
|
||||
Computed signals are read‑only.
|
||||
|
||||
### 4. Effect
|
||||
|
||||
If you call `$` with a function **inside a component or runtime**, it becomes an effect that runs immediately and re‑runs whenever any of its dependencies change. The effect can return a cleanup function.
|
||||
|
||||
```js
|
||||
$(() => {
|
||||
console.log('Count changed:', count());
|
||||
});
|
||||
|
||||
$(() => {
|
||||
const timer = setInterval(() => console.log('tick'), 1000);
|
||||
return () => clearInterval(timer); // cleanup on each re‑run or unmount
|
||||
});
|
||||
```
|
||||
|
||||
Effects are automatically stopped when the component is unmounted (see `$.mount`).
|
||||
|
||||
### 5. Persistent Signal
|
||||
|
||||
If you pass a second argument (a string key), the signal is synchronized with `localStorage`. The initial value is loaded from storage, and every write is saved.
|
||||
|
||||
```js
|
||||
const theme = $('light', 'theme-key');
|
||||
const settings = $({ volume: 50 }, 'app-settings');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## DOM Creation
|
||||
|
||||
### `$.html(tag, props, children)`
|
||||
|
||||
Creates a DOM element with the given tag, properties, and children.
|
||||
|
||||
```js
|
||||
const el = $.html('div', { class: 'container' }, 'Hello');
|
||||
```
|
||||
|
||||
If the second argument is not an object, it is treated as children:
|
||||
|
||||
```js
|
||||
$.html('div', 'Hello'); // no props
|
||||
$.html('div', [h1('Title'), p('Text')]); // children array
|
||||
```
|
||||
|
||||
### Tag Shortcuts
|
||||
|
||||
Common tags are directly available as functions:
|
||||
|
||||
```js
|
||||
div(props, children)
|
||||
span(props, children)
|
||||
p()
|
||||
h1(), h2(), h3()
|
||||
ul(), li()
|
||||
button()
|
||||
input()
|
||||
label()
|
||||
form()
|
||||
section()
|
||||
a()
|
||||
img()
|
||||
nav()
|
||||
hr()
|
||||
```
|
||||
|
||||
All tag functions call `$.html` internally.
|
||||
|
||||
---
|
||||
|
||||
## Props
|
||||
|
||||
Props are objects passed to `$.html` or tag functions.
|
||||
|
||||
### Static Attributes
|
||||
|
||||
Standard HTML attributes are set as strings or booleans.
|
||||
|
||||
```js
|
||||
div({ class: 'btn', id: 'submit', disabled: true }, 'Click');
|
||||
```
|
||||
|
||||
### Reactive Attributes (prefixed with `$`)
|
||||
|
||||
Attributes starting with `$` are reactive. Their value can be a static value, a signal, or a function returning a value. The attribute is updated automatically when the value changes.
|
||||
|
||||
```js
|
||||
const isActive = $(false);
|
||||
div({ $class: () => isActive() ? 'active' : 'inactive' });
|
||||
```
|
||||
|
||||
Special reactive attributes:
|
||||
- `$value` – two‑way binding for `<input>`, `<textarea>`, etc.
|
||||
- `$checked` – two‑way binding for checkboxes/radios.
|
||||
|
||||
When `$value` or `$checked` is a function (signal), the element’s `value`/`checked` property is updated, and the element’s `input`/`change` event will update the signal.
|
||||
|
||||
```js
|
||||
const name = $('');
|
||||
input({ $value: name }); // auto‑updates name when user types
|
||||
```
|
||||
|
||||
### Event Handlers (prefixed with `on`)
|
||||
|
||||
Events are attached with `onEventName`. The event name is case‑insensitive and can be followed by modifiers separated by dots.
|
||||
|
||||
```js
|
||||
button({ onclick: () => console.log('clicked') }, 'Click');
|
||||
```
|
||||
|
||||
Modifiers:
|
||||
- `.prevent` – calls `e.preventDefault()`
|
||||
- `.stop` – calls `e.stopPropagation()`
|
||||
- `.once` – removes listener after first call
|
||||
|
||||
Example:
|
||||
|
||||
```js
|
||||
button({ onClick.prevent: handleSubmit }, 'Submit');
|
||||
div({ onClick.stop: handleDivClick }, 'Click');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Children
|
||||
|
||||
Children can be:
|
||||
|
||||
- **String** – inserted as text node.
|
||||
- **DOM Node** – inserted directly.
|
||||
- **Array** – each item is processed recursively.
|
||||
- **Function** – treated as reactive content. The function is called every time its dependencies change, and the result is rendered in place.
|
||||
|
||||
```js
|
||||
const count = $(0);
|
||||
div([
|
||||
'Static text',
|
||||
() => `Count: ${count()}`, // updates automatically
|
||||
button({ onclick: () => count(count()+1) }, '+')
|
||||
]);
|
||||
```
|
||||
|
||||
When a function child returns an array, each element is inserted.
|
||||
|
||||
---
|
||||
|
||||
## Routing
|
||||
|
||||
### `$.router(routes)`
|
||||
|
||||
Creates a router outlet that displays the component matching the current hash (`#/`). Returns a DOM element (a `div` with class `router-outlet`) that can be inserted anywhere.
|
||||
|
||||
`routes` is an array of objects with `path` and `component` properties.
|
||||
|
||||
- `path`: string like `/`, `/users`, `/users/:id`. Dynamic parameters are prefixed with `:`.
|
||||
- `component`: a function that receives an object of params and returns a DOM node / runtime.
|
||||
|
||||
A `*` path serves as a 404 catch‑all.
|
||||
|
||||
```js
|
||||
const routes = [
|
||||
{ path: '/', component: () => Home() },
|
||||
{ path: '/users/:id', component: (params) => UserDetail(params.id) },
|
||||
{ path: '*', component: () => NotFound() }
|
||||
];
|
||||
|
||||
const outlet = $.router(routes);
|
||||
document.body.appendChild(outlet);
|
||||
```
|
||||
|
||||
### `$.router.go(path)`
|
||||
|
||||
Programmatically navigates to a new hash path.
|
||||
|
||||
```js
|
||||
$.router.go('/users/123');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Mounting
|
||||
|
||||
### `$.mount(component, target)`
|
||||
|
||||
Mounts a component into a DOM element. The component can be a function (called to produce a runtime) or a static DOM node.
|
||||
|
||||
- `target`: a CSS selector string or a DOM element.
|
||||
- Returns the runtime instance (with a `destroy` method).
|
||||
|
||||
If the target already has a mounted SigPro instance, it is automatically destroyed before the new one is mounted.
|
||||
|
||||
```js
|
||||
$.mount(() => div('Hello'), '#app');
|
||||
```
|
||||
|
||||
### Component Functions
|
||||
|
||||
A component function receives an object with `onCleanup` which can be used to register cleanup callbacks.
|
||||
|
||||
```js
|
||||
const MyComponent = ({ onCleanup }) => {
|
||||
const timer = setInterval(() => {}, 1000);
|
||||
onCleanup(() => clearInterval(timer));
|
||||
return div('Component');
|
||||
};
|
||||
```
|
||||
|
||||
Components can return:
|
||||
- a DOM node
|
||||
- an array of nodes
|
||||
- a runtime object (like one returned from another `$.mount` call, but typically you return a node)
|
||||
|
||||
---
|
||||
|
||||
## Memory Management
|
||||
|
||||
SigPro automatically cleans up resources to prevent leaks:
|
||||
|
||||
- **WeakMaps** for proxies and mounted nodes allow garbage collection.
|
||||
- Every effect, event listener, or reactive attribute created through SigPro is stored in `_cleanups` on the element and removed when the element is swept.
|
||||
- The `sweep` function recursively cleans all child nodes and their attached effects.
|
||||
- When a component is unmounted (by calling `destroy()` or via router), all its effects and event listeners are removed.
|
||||
|
||||
Effects that return a cleanup function have that function called before the next run and on unmount.
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
### Counter with localStorage persistence
|
||||
|
||||
```js
|
||||
const Counter = () => {
|
||||
const count = $(0, 'counter'); // persistent signal
|
||||
return div([
|
||||
span(() => `Count: ${count()}`),
|
||||
button({ onclick: () => count(count() + 1) }, '+'),
|
||||
button({ onclick: () => count(count() - 1) }, '-')
|
||||
]);
|
||||
};
|
||||
|
||||
$.mount(Counter, '#app');
|
||||
```
|
||||
|
||||
### Form with two‑way binding
|
||||
|
||||
```js
|
||||
const Form = () => {
|
||||
const name = $('');
|
||||
const email = $('');
|
||||
return form({ onsubmit: (e) => e.preventDefault() }, [
|
||||
label('Name:'),
|
||||
input({ $value: name, placeholder: 'Your name' }),
|
||||
label('Email:'),
|
||||
input({ $value: email, type: 'email' }),
|
||||
p(() => `Hello, ${name() || 'stranger'}`)
|
||||
]);
|
||||
};
|
||||
```
|
||||
|
||||
### Router with parameters
|
||||
|
||||
```js
|
||||
const routes = [
|
||||
{ path: '/', component: () => div('Home') },
|
||||
{ path: '/user/:id', component: (p) => div(`User ${p.id}`) }
|
||||
];
|
||||
|
||||
const App = () => div([
|
||||
nav([
|
||||
a({ href: '#/' }, 'Home'),
|
||||
a({ href: '#/user/42' }, 'User 42')
|
||||
]),
|
||||
$.router(routes)
|
||||
]);
|
||||
|
||||
$.mount(App, '#app');
|
||||
```
|
||||
|
||||
### Effect with cleanup
|
||||
|
||||
```js
|
||||
const Clock = () => {
|
||||
const time = $(new Date().toLocaleTimeString());
|
||||
$(() => {
|
||||
const interval = setInterval(() => {
|
||||
time(new Date().toLocaleTimeString());
|
||||
}, 1000);
|
||||
return () => clearInterval(interval);
|
||||
});
|
||||
return span(() => time());
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Notes for AI
|
||||
|
||||
- SigPro is entirely self‑contained. No external libraries are needed.
|
||||
- All reactivity is based on signals and proxies.
|
||||
- To update the DOM, just change a signal – the UI updates automatically.
|
||||
- Use `$` for state, `$.html` (or tag shortcuts) for DOM.
|
||||
- The router uses hash navigation only; it does not use the History API.
|
||||
- There is no built‑in `_if` or `_for`; those are part of optional UI plugins. For conditional rendering, use a function child that returns different content based on a signal.
|
||||
- For lists, a common pattern is to create a function child that maps over an array and returns an array of elements. However, the core does not provide keyed diffing; that is left to the user or plugin.
|
||||
|
||||
For any further details, refer to the source code of `$.html`, `$.router`, and the reactive internals. The API is stable and minimal.
|
||||
```
|
||||
Reference in New Issue
Block a user