mirror of
https://github.com/jaandrle/deka-dom-el
synced 2024-11-24 09:29:37 +01:00
104 lines
6.0 KiB
JavaScript
104 lines
6.0 KiB
JavaScript
import { simplePage } from "./layout/simplePage.html.js";
|
||
|
||
import { el } from "deka-dom-el";
|
||
import { example } from "./components/example.html.js";
|
||
import { h3 } from "./components/pageUtils.html.js";
|
||
import { mnemonic } from "./components/mnemonic/observables-init.js";
|
||
import { code } from "./components/code.html.js";
|
||
/** @param {string} url */
|
||
const fileURL= url=> new URL(url, import.meta.url);
|
||
|
||
/** @param {import("./types.d.ts").PageAttrs} attrs */
|
||
export function page({ pkg, info }){
|
||
const page_id= info.id;
|
||
return el(simplePage, { info, pkg }).append(
|
||
el("h2", "Using observables to manage reactivity"),
|
||
el("p").append(
|
||
"How a program responds to variable data or user",
|
||
" interactions is one of the fundamental problems of programming.",
|
||
" If we desire to solve the issue in a declarative manner,",
|
||
" observables may be a viable approach.",
|
||
),
|
||
el(code, { src: fileURL("./components/examples/observables/intro.js"), page_id }),
|
||
|
||
el(h3, "Introducing observables"),
|
||
el("p").append(
|
||
"Using observables, we split program logic into the three parts.",
|
||
" Firstly (α), we create a variable (constant) representing reactive",
|
||
" value. Somewhere later, we can register (β) a logic reacting",
|
||
" to the observable value changes. Similarly, in a remaining part (γ), we",
|
||
" can update the observable value."
|
||
),
|
||
el(example, { src: fileURL("./components/examples/observables/observables.js"), page_id }),
|
||
el("p").append(
|
||
"All this is just an example of ",
|
||
el("a", { textContent: "Event-driven programming", href: "https://en.wikipedia.org/wiki/Event-driven_programming", title: "Wikipedia: Event-driven programming" }),
|
||
" and ",
|
||
el("a", { textContent: "Publish–subscribe pattern", href: "https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern", title: "Wikipedia: Publish–subscribe pattern" }),
|
||
" (compare for example with ", el("a", { textContent: "fpubsub library", href: "https://www.npmjs.com/package/fpubsub", title: "NPM package: fpubsub" }), ").",
|
||
" All three parts can be in some manner independent and still connected",
|
||
" to the same reactive entity."
|
||
),
|
||
el("p").append(
|
||
"Observables are implemented in the library as functions. To see current value",
|
||
" of observable, just call it without any arguments ", el("code", "console.log(observable())"), ".",
|
||
" To update the observable value, pass any argument ", el("code", "observable('a new value')"), ".",
|
||
" For listenning the observable value changes, use ", el("code", "O.on(observable, console.log)"), "."
|
||
),
|
||
el("p").append(
|
||
"Similarly to the ", el("code", "on"), " function to register DOM events listener.",
|
||
" You can use ", el("code", "AbortController"), "/", el("code", "AbortSignal"), " to",
|
||
" ", el("em", "off"), "/stop listenning. In example, you also found the way for representing",
|
||
" “live” piece of code computation pattern (derived observable):"
|
||
),
|
||
el(example, { src: fileURL("./components/examples/observables/computations-abort.js"), page_id }),
|
||
|
||
el(h3, "Observables and actions"),
|
||
el("p").append(
|
||
el("code", "O(/* primitive */)"), " allows you to declare simple reactive variables, typically",
|
||
" around ", el("em", "immutable"), " ", el("a", { textContent: "primitive types", title: "Primitive | MDN", href: "https://developer.mozilla.org/en-US/docs/Glossary/Primitive" }), ".",
|
||
" ",
|
||
"However, it may also be necessary to use reactive arrays, objects, or other complex reactive structures."
|
||
),
|
||
el(example, { src: fileURL("./components/examples/observables/actions-demo.js"), page_id }),
|
||
el("p", "…but typical user-case is object/array (maps, sets and other mutable objects):"),
|
||
el(example, { src: fileURL("./components/examples/observables/actions-todos.js"), page_id }),
|
||
el("p").append(
|
||
"In some way, you can compare it with ", el("a", { textContent: "useReducer", href: "https://react.dev/reference/react/useReducer", title: "useReducer hook | React docs" }),
|
||
" hook from React. So, the ", el("code", "O(<data>, <actions>)"), " pattern creates",
|
||
" a store “machine”. We can then invoke (dispatch) registered action by calling",
|
||
" ", el("code", "O.action(<observable>, <name>, ...<args>)"), " after the action call",
|
||
" the observable calls all its listeners. This can be stopped by calling ", el("code", "this.stopPropagation()"),
|
||
" in the method representing the given action. As it can be seen in examples, the “store” value is",
|
||
" available also in the function for given action (", el("code", "this.value"), ")."
|
||
),
|
||
|
||
el(h3, "Reactive DOM attributes and elements"),
|
||
el("p", "There are on basic level two distinc situation to mirror dynamic value into the DOM/UI"),
|
||
el("ol").append(
|
||
el("li", "to change some attribute(s) of existing element(s)"),
|
||
el("li", "to generate elements itself dynamically – this covers conditions and loops")
|
||
),
|
||
el(example, { src: fileURL("./components/examples/observables/dom-attrs.js"), page_id }),
|
||
el("p").append(
|
||
"To derived attribute based on value of observable variable just use the observable as",
|
||
" a value of the attribute (", el("code", "assign(element, { attribute: O('value') })"), ").",
|
||
" ", el("code", "assign"), "/", el("code", "el"), " provides ways to glue reactive attributes/classes",
|
||
" more granularly into the DOM. Just use dedicated build-in attributes ", el("code", "dataset"), ", ",
|
||
el("code", "ariaset"), " and ", el("code", "classList"), "."
|
||
),
|
||
el("p").append(
|
||
"For computation, you can use the “derived observable” (see above) like ", el("code", "assign(element, { textContent: O(()=> 'Hello '+WorldObservable()) })"), ".",
|
||
" ",
|
||
"This is read-only observable its value is computed based on given function and updated when any observable used in the function changes."
|
||
),
|
||
el("p").append(
|
||
"To represent part of the template filled dynamically based on the observable value use ", el("code", "O.el(observable, DOMgenerator)"), ".",
|
||
" This was already used in the todo example above or see:"
|
||
),
|
||
el(example, { src: fileURL("./components/examples/observables/dom-el.js"), page_id }),
|
||
|
||
el(mnemonic)
|
||
);
|
||
}
|