mirror of
https://github.com/jaandrle/deka-dom-el
synced 2024-11-21 23:39:37 +01:00
76 lines
4.2 KiB
Markdown
76 lines
4.2 KiB
Markdown
**WIP** (the experimentation phase) | [source code on GitHub](https://github.com/jaandrle/deka-dom-el) | [*mirrored* on Gitea](https://gitea.jaandrle.cz/jaandrle/deka-dom-el)
|
||
|
||
***Vanilla for flavouring — a full-fledged feast for large projects***
|
||
|
||
*…use simple DOM API by default and library tools and logic when you need them*
|
||
|
||
```js
|
||
document.body.append(
|
||
el("h1", "Hello World 👋"),
|
||
el("p", "See some syntax examples here:"),
|
||
el("ul").append(
|
||
el("li").append(
|
||
el("a", { textContent: "Link to the library repo", title: "Deka DOM El — GitHub", href: "https://github.com/jaandrle/deka-dom-el" })
|
||
),
|
||
el("li").append(
|
||
"Use extended Vanilla JavaScript DOM/IDL API: ",
|
||
el("span", { textContent: "» this is a span with class=cN and data-a=A, data-b=B «", className: "cN", dataset: { a: "A", b: "B" } })
|
||
),
|
||
el("li").append(
|
||
el(component, { textContent: "A component", className: "example" }, on("change", console.log))
|
||
)
|
||
)
|
||
|
||
);
|
||
function component({ textContent, className }){
|
||
const value= O("onchange");
|
||
|
||
return el().append(
|
||
el("p", { textContent, className }),
|
||
el("p", { className: [ className, "second-line" ] }).append(
|
||
"…with reactivity: ", el("em", { style: { fontWeight: "bold" }, ariaset: { live: "polite" }, textContent: value }),
|
||
),
|
||
el("input", { type: "text", value: value() }, on("change", event=> value(event.target.value)))
|
||
);
|
||
}
|
||
```
|
||
# Deka DOM Elements
|
||
Creating reactive elements, components and Web components using [IDL](https://developer.mozilla.org/en-US/docs/Glossary/IDL)/JavaScript DOM API and signals/observables
|
||
([Signals — whats going on behind the scenes | by Ryan Hoffnan | ITNEXT](https://itnext.io/signals-whats-going-on-behind-the-scenes-ec858589ea63), [The Evolution of Signals in JavaScript - DEV Community](https://dev.to/this-is-learning/the-evolution-of-signals-in-javascript-8ob) or [Observer pattern - Wikipedia](https://en.wikipedia.org/wiki/Observer_pattern)).
|
||
|
||
## Inspiration and suggested alternatives
|
||
- my previous library (mostly used internaly): [jaandrle/dollar_dom_component: Functional DOM components without JSX and virtual DOM.](https://github.com/jaandrle/dollar_dom_component)
|
||
- [vanjs-org/van: 🍦 VanJS: World's smallest reactive UI framework. Incredibly Powerful, Insanely Small - Everyone can build a useful UI app in an hour.](https://github.com/vanjs-org/van)
|
||
- [hyperhype/hyperscript: Create HyperText with JavaScript.](https://github.com/hyperhype/hyperscript)
|
||
- [adamhaile/S: S.js - Simple, Clean, Fast Reactive Programming in Javascript](https://github.com/adamhaile/S) ([adamhaile/surplus: High performance JSX web views for S.js applications](https://github.com/adamhaile/surplus))
|
||
- [potch/signals: a small reactive signals library](https://github.com/potch/signals)
|
||
|
||
## Why an another one?
|
||
This library falls somewhere between van/hyperscript and [solid-js](https://github.com/solidjs/solid) in terms of size, complexity,
|
||
and usability.
|
||
|
||
Another goal is to proceed in the best spirit of functional programming. This involves starting with
|
||
pure JavaScript (DOM API) and gradually adding auxiliary functions, ranging from “minor” improvements
|
||
to the capability of writing complete declarative reactive UI templates.
|
||
|
||
As a result, any “internal” function (`assign`, `classListDeclarative`, `on`, `dispatchEvent`, …, `O`, …)
|
||
can be used independently, although they are primarily designed for use in combination. This can also,
|
||
hopefully, help in integrating the library into existing projects.
|
||
|
||
To balance these requirements, numerous compromises have been made. To summarize:
|
||
- [ ] Library size: 10–15kB minified (the original goal was a maximum of 10kB)
|
||
- [x] Optional use of *observables* with the ability to register *your own signals/observables implementation*
|
||
- [x] *No build step required*
|
||
- [x] Preference for a *declarative/functional* approach
|
||
- [x] Focus on zero/minimal dependencies
|
||
- [ ] Support for/enhancement of custom elements (web components)
|
||
- [x] Support for SSR ([jsdom](https://github.com/jsdom/jsdom))
|
||
- [ ] WIP providing types
|
||
|
||
## First steps
|
||
- [**Guide**](https://jaandrle.github.io/deka-dom-el)
|
||
- Documentation
|
||
- Installation
|
||
- npm
|
||
- [dist/](dist/) (`https://cdn.jsdelivr.net/gh/jaandrle/deka-dom-el/dist/`…)
|