sprae
Version:
DOM microhydration
519 lines (376 loc) • 16.4 kB
Markdown
# ∴ spræ [](https://github.com/dy/sprae/actions/workflows/node.js.yml) [](https://bundlephobia.com/package/sprae) [](https://www.npmjs.com/package/sprae)
> DOM tree microhydration
_Sprae_ is open & minimalistic progressive enhancement framework with _preact-signals_ reactivity.<br/>
Useful for SPAs, PWAs, lightweight UI or nextjs / SSR (see [JSX](#jsx)).<br/>
An alternative to _alpine_, _petite-vue_, _lucia_ etc (see [why](#justification)).
## Usage
```html
<div id="container" :if="user">
Hello <span :text="user.name">there</span>.
</div>
<script type="module">
import sprae from './sprae.js' // https://unpkg.com/sprae/dist/sprae.min.js
// init
const container = document.querySelector('#container');
const state = sprae(container, { user: { name: 'friend' } })
// update
state.user.name = 'love'
</script>
```
Sprae evaluates `:`-directives and evaporates them, returning reactive state for updates.
### UMD
`sprae.umd` enables sprae via CDN, CJS, AMD etc.
```html
<script src="https://unpkg.com/sprae/dist/sprae.umd"></script>
<script>
window.sprae; // global standalone
</script>
```
### Autoinit
`sprae.auto` autoinits sprae on document body.
```html
<!-- Optional attr `prefix` (by default ':'). -->
<script src="https://unpkg.com/sprae/dist/sprae.auto" prefix="js-"></script>
```
## Directives
#### `:if="condition"`, `:else`
Control flow of elements.
```html
<span :if="foo">foo</span>
<span :else :if="bar">bar</span>
<span :else>baz</span>
<!-- fragment -->
<template :if="foo">foo <span>bar</span> baz</template>
```
#### `:each="item, index? in items"`
Multiply element.
```html
<ul><li :each="item in items" :text="item" /></ul>
<!-- cases -->
<li :each="item, idx in array" />
<li :each="value, key in object" />
<li :each="count, idx in number" />
<!-- fragment -->
<template :each="item in items">
<dt :text="item.term"/>
<dd :text="item.definition"/>
</template>
```
#### `:text="value"`
Set text content of an element.
```html
Welcome, <span :text="user.name">Guest</span>.
<!-- fragment -->
Welcome, <template :text="user.name"><template>.
```
#### `:class="value"`
Set class value.
```html
<div :class="foo"></div>
<!-- appends to static class -->
<div class="bar" :class="baz"></div>
<!-- array/object, a-la clsx -->
<div :class="['foo', bar && 'bar', { baz }]"></div>
```
#### `:style="value"`
Set style value.
```html
<span style="'display: inline-block'"></span>
<!-- extends static style -->
<div style="foo: bar" :style="'bar-baz: qux'">
<!-- object -->
<div :style="{barBaz: 'qux'}"></div>
<!-- set CSS variable -->
<div :style="{'--bar-baz': qux}"></div>
```
#### `:value="value"`
Set value to/from an input, textarea or select (like alpinejs `x-model`).
```html
<input :value="value" />
<textarea :value="value" />
<!-- selects right option & handles selected attr -->
<select :value="selected">
<option :each="i in 5" :value="i" :text="i"></option>
</select>
<!-- handles checked attr -->
<input type="checkbox" :value="item.done" />
```
#### `:<prop>="value"`, `:="values"`
Set any attribute(s).
```html
<label :for="name" :text="name" />
<!-- multiple attributes -->
<input :id:name="name" />
<!-- spread attributes -->
<input :="{ id: name, name, type: 'text', value }" />
```
#### `:with="values"`
Define values for a subtree.
```html
<x :with="{ foo: 'bar' }">
<y :with="{ baz: 'qux' }" :text="foo + baz"></y>
</x>
```
#### `:fx="code"`
Run effect, not changing any attribute.
```html
<div :fx="a.value ? foo() : bar()" />
<!-- cleanup function -->
<div :fx="id = setInterval(tick, 1000), () => clearInterval(id)" />
```
#### `:ref="name"`, `:ref="el => (...)"`
Expose element in state with `name` or get reference to element.
```html
<div :ref="card" :fx="handle(card)"></div>
<!-- local reference -->
<li :each="item in items" :ref="li">
<input :onfocus..onblur="e => (li.classList.add('editing'), e => li.classList.remove('editing'))"/>
</li>
<!-- set innerHTML -->
<div :ref="el => el.innerHTML = '...'"></div>
<!-- mount / unmount -->
<textarea :ref="el => (/* onmount */, () => (/* onunmount */))" :if="show"></textarea>
```
#### `:on<event>="handler"`, `:on<in>..on<out>="handler"`
Attach event(s) listener with optional modifiers.
```html
<input type="checkbox" :onchange="e => isChecked = e.target.value">
<!-- multiple events -->
<input :value="text" :oninput:onchange="e => text = e.target.value">
<!-- sequence of events -->
<button :onfocus..onblur="e => (handleFocus(), e => handleBlur())">
<!-- modifiers -->
<button :onclick.throttle-500="handler">Not too often</button>
```
##### Modifiers:
* `.once`, `.passive`, `.capture` – listener [options](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#options).
* `.prevent`, `.stop` (`.immediate`) – prevent default or stop (immediate) propagation.
* `.window`, `.document`, `.parent`, `.outside`, `.self` – specify event target.
* `.throttle-<ms>`, `.debounce-<ms>` – defer function call with one of the methods.
* `.<key>` – filtered by [`event.key`](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values):
* `.ctrl`, `.shift`, `.alt`, `.meta`, `.enter`, `.esc`, `.tab`, `.space` – direct key
* `.delete` – delete or backspace
* `.arrow` – up, right, down or left arrow
* `.digit` – 0-9
* `.letter` – A-Z, a-z or any [unicode letter](https://unicode.org/reports/tr18/#General_Category_Property)
* `.char` – any non-space character
* `.ctrl-<key>, .alt-<key>, .meta-<key>, .shift-<key>` – key combinations, eg. `.ctrl-alt-delete` or `.meta-x`.
* `.*` – any other modifier has no effect, but allows binding multiple handlers to same event (like jQuery event classes).
#### `:data="values"`
Set `data-*` attributes. CamelCase is converted to dash-case.
```html
<input :data="{foo: 1, barBaz: true}" />
<!-- <input data-foo="1" data-bar-baz /> -->
```
#### `:aria="values"`
Set `aria-*` attributes. Boolean values are stringified.
```html
<input role="combobox" :aria="{
controls: 'joketypes',
autocomplete: 'list',
expanded: false,
activeOption: 'item1',
activedescendant: ''
}" />
<!--
<input role="combobox" aria-controls="joketypes" aria-autocomplete="list" aria-expanded="false" aria-active-option="item1" aria-activedescendant>
-->
```
<!--
#### `:onvisible..oninvisible="e => e => {}"`
Trigger when element is in/out of the screen.
```html
<div :onvisible..oninvisible="e => (
e.target.classList.add('visible'),
e => e.target.classlist.remove('visible')
)"/>
```
#### `:onmount..onunmount="e => e => {}"`
Trigger when element is connected / disconnected from DOM.
```html
<div :onmount..onunmount="e => (dispose = init(), e => dispose())"/>
```
-->
## Signals
Sprae uses _preact-flavored signals_ for reactivity and can take _signal_ values as inputs.<br/>
Signals can be switched to an alternative preact/compatible implementation:
```js
import sprae from 'sprae';
import { signal, computed, effect, batch, untracked } from 'sprae/signal';
import * as signals from '@preact/signals-core';
// switch sprae signals to @preact/signals-core
sprae.use(signals);
// use signal as state value
const name = signal('Kitty')
sprae(el, { name });
// update state
name.value = 'Dolly';
```
Provider | Size | Feature
:---|:---|:---
[`ulive`](https://ghub.io/ulive) | 350b | Minimal implementation, basic performance, good for small states.
[`@webreflection/signal`](https://ghub.io/@webreflection/signal) | 531b | Class-based, better performance, good for small-medium states.
[`usignal`](https://ghub.io/usignal) | 850b | Class-based with optimizations, good for medium states.
[`@preact/signals-core`](https://ghub.io/@preact/signals-core) | 1.47kb | Best performance, good for any states, industry standard.
[`signal-polyfill`](https://ghub.io/signal-polyfill) | 2.5kb | Proposal signals. Use via [adapter](https://gist.github.com/dy/bbac687464ccf5322ab0e2fd0680dc4d).
## Evaluator
Expressions use _new Function_ as default evaluator, which is fast & compact way, but violates "unsafe-eval" CSP.
To make eval stricter & safer, as well as sandbox expressions, an alternative evaluator can be used, eg. _justin_:
```js
import sprae from 'sprae'
import justin from 'subscript/justin'
sprae.use({compile: justin}) // set up justin as default compiler
```
[_Justin_](https://github.com/dy/subscript#justin) is minimal JS subset that avoids "unsafe-eval" CSP and provides sandboxing.
###### Operators:
`++ -- ! - + * / % ** && || ??`<br/>
`= < <= > >= == != === !==`<br/>
`<< >> >>> & ^ | ~ ?: . ?. [] ()=>{} in`<br/>
`= += -= *= /= %= **= &&= ||= ??= ... ,`
###### Primitives:
`[] {} "" ''`<br/>
`1 2.34 -5e6 0x7a`<br/>
`true false null undefined NaN`
## Custom Build
_Sprae_ can be tailored to project needs via `sprae/core`:
```js
// sprae.custom.js
import sprae, { dir, parse } from 'sprae/core'
import * as signals from '@preact/signals'
import compile from 'subscript'
// standard directives
import 'sprae/directive/default.js'
import 'sprae/directive/if.js'
import 'sprae/directive/text.js'
// custom directive :id="expression"
dir('id', (el, state, expr) => {
// ...init
return value => el.id = value // update
})
sprae.use({
// configure signals
...signals,
// configure compiler
compile,
// custom prefix, default is `:`
prefix: 'js-'
})
```
## JSX
Sprae works with JSX via custom prefix.
Case: keep nextjs server components intact by offloading dynamic UI logic (active nav, tabs etc) to sprae instead of client components:
```jsx
// app/page.jsx - server component
export default function Page() {
return <>
<nav id="nav">
<a href="/" js-class="location.pathname === '/' && 'active'">Home</a>
<a href="/about" js-class="location.pathname === '/about' && 'active'">About</a>
</nav>
...
</>
}
```
```jsx
// layout.jsx
import Script from 'next/script'
export default function Layout({ children }) {
return <>
{children}
<Script src="https://unpkg.com/sprae" prefix="js-" />
</>
}
```
## Hints
* To prevent [FOUC](https://en.wikipedia.org/wiki/Flash_of_unstyled_content) add `<style>[\:each],[\:if],[\:else] {visibility: hidden}</style>`.
* Attributes order matters, eg. `<li :each="el in els" :text="el.name"></li>` is not the same as `<li :text="el.name" :each="el in els"></li>`.
* Invalid self-closing tags like `<a :text="item" />` will cause error. Valid self-closing tags are: `li`, `p`, `dt`, `dd`, `option`, `tr`, `td`, `th`, `input`, `img`, `br`.
* Properties prefixed with `_` are untracked: `let state = sprae(el, {_x:2}); state._x++; // no effect`.
* To destroy state and detach sprae handlers, call `element[Symbol.dispose]()`.
* State getters/setters work as computed effects, eg. `sprae(el, { x:1, get x2(){ return this.x * 2} })`.
* `this` is not used, to get current element use `:ref`.
* `event` is not used, `:on*` attributes expect a function with event argument `:onevt="event => handle()"`, see [#46](https://github.com/dy/sprae/issues/46).
* `key` is not used, `:each` uses direct list mapping instead of DOM diffing.
* `await` is not supported in attributes, it’s a strong indicator you need to put these methods into state.
* `:ref` comes after `:if` for mount/unmount events `<div :if="cond" :ref="(init(), ()=>dispose())"></div>`.
## Justification
Modern frontend stack is complex and obese, like overprocessed non-organic food. There are healthy alternatives:
* [Template-parts](https://github.com/dy/template-parts) is native, but stuck with HTML quirks ([parsing table](https://github.com/github/template-parts/issues/24), [SVG attributes](https://github.com/github/template-parts/issues/25), [liquid syntax](https://shopify.github.io/liquid/tags/template/#raw) conflict etc).
* [Alpine](https://github.com/alpinejs/alpine) / [petite-vue](https://github.com/vuejs/petite-vue) / [lucia](https://github.com/aidenybai/lucia) are useful for SSR, but excessive (`:`, `x-`, `{}`, `@`, `$`), [encapsulated](https://github.com/alpinejs/alpine/discussions/3223) and not care about size/performance as much.
_Sprae_ holds open & minimalistic philosophy:
* Minimal syntax `:`.
* _Signals_ for reactivity.
* Pluggable directives, configurable internals.
* Small, safe & performant.
* Bits of organic sugar.
* Aims at making developers happy 🫰
<!-- > Perfection is not when there is nothing to add, but when there is nothing to take away. -->
<!--
| | [AlpineJS](https://github.com/alpinejs/alpine) | [Petite-Vue](https://github.com/vuejs/petite-vue) | Sprae |
|-----------------------|-------------------|-------------------|------------------|
| _Size_ | ~10KB | ~6KB | ~5KB |
| _Memory_ | 5.05 | 3.16 | 2.78 |
| _Performance_ | 2.64 | 2.43 | 1.76 |
| _CSP_ | Limited | No | Yes |
| _SSR_ | No | No | No |
| _Evaluation_ | [`new AsyncFunction`](https://github.com/alpinejs/alpine/blob/main/packages/alpinejs/src/evaluator.js#L81) | [`new Function`](https://github.com/vuejs/petite-vue/blob/main/src/eval.ts#L20) | [`new Function`]() / [justin](https://github.com/dy/subscript) |
| _Reactivity_ | `Alpine.store` | _@vue/reactivity_ | _signals_ |
| _Sandboxing_ | No | No | Yes |
| _Directives_ | `:`, `x-`, `{}` | `:`, `v-`, `@`, `{}` | `:` |
| _Magic_ | `$data` | `$app` | - |
| _Fragments_ | Yes | No | Yes |
| _Plugins_ | Yes | No | Yes |
| _Modifiers_ | Yes | No | Yes |
-->
<!--
<details>
<summary><strong>Benchmark</strong></summary>
See [js-framework-benchmark](https://krausest.github.io/js-framework-benchmark/current.html#eyJmcmFtZXdvcmtzIjpbIm5vbi1rZXllZC9wZXRpdGUtdnVlIiwibm9uLWtleWVkL3NwcmFlIl0sImJlbmNobWFya3MiOlsiMDFfcnVuMWsiLCIwMl9yZXBsYWNlMWsiLCIwM191cGRhdGUxMHRoMWtfeDE2IiwiMDRfc2VsZWN0MWsiLCIwNV9zd2FwMWsiLCIwNl9yZW1vdmUtb25lLTFrIiwiMDdfY3JlYXRlMTBrIiwiMDhfY3JlYXRlMWstYWZ0ZXIxa194MiIsIjA5X2NsZWFyMWtfeDgiLCIyMV9yZWFkeS1tZW1vcnkiLCIyMl9ydW4tbWVtb3J5IiwiMjNfdXBkYXRlNS1tZW1vcnkiLCIyNV9ydW4tY2xlYXItbWVtb3J5IiwiMjZfcnVuLTEway1tZW1vcnkiLCIzMV9zdGFydHVwLWNpIiwiMzRfc3RhcnR1cC10b3RhbGJ5dGVzIiwiNDFfc2l6ZS11bmNvbXByZXNzZWQiLCI0Ml9zaXplLWNvbXByZXNzZWQiXSwiZGlzcGxheU1vZGUiOjF9).
</details>
-->
<!--
<details>
<summary>How to run</summary>
```sh
# prerequisite
npm ci
npm run install-server
npm start
# build
cd frameworks/non-keyed/sprae
npm ci
npm run build-prod
# bench
[cd ../../../webdriver-ts
npm ci
npm run compile]
npm run bench keyed/sprae
# show results
[cd ../webdriver-ts-results
npm ci]
cd ../webdriver-ts
npm run results
```
</details>
-->
<!-- ## See also -->
<!--
## Alternatives
* [Alpine](https://github.com/alpinejs/alpine)
* ~~[Lucia](https://github.com/aidenybai/lucia)~~ deprecated
* [Petite-vue](https://github.com/vuejs/petite-vue)
* [nuejs](https://github.com/nuejs/nuejs)
* [hmpl](https://github.com/hmpl-language/hmpl)
-->
## Examples
* ToDo MVC: [demo](https://dy.github.io/sprae/examples/todomvc), [code](https://github.com/dy/sprae/blob/main/examples/todomvc.html)
* JS Framework Benchmark: [demo](https://dy.github.io/sprae/examples/js-framework-benchmark), [code](https://github.com/dy/sprae/blob/main/examples/js-framework-benchmark.html)
* Wavearea: [demo](https://dy.github.io/wavearea?src=//cdn.freesound.org/previews/586/586281_2332564-lq.mp3), [code](https://github.com/dy/wavearea)
* Carousel: [demo](https://rwdevelopment.github.io/sprae_js_carousel/), [code](https://github.com/RWDevelopment/sprae_js_carousel)
* Tabs: [demo](https://rwdevelopment.github.io/sprae_js_tabs/), [code](https://github.com/RWDevelopment/sprae_js_tabs?tab=readme-ov-file)
* Prostogreen [demo](https://web-being.org/prostogreen/), [code](https://github.com/web-being/prostogreen/)
<!--
## See Also
* [nadi](https://github.com/dy/nadi) - 101 signals. -->
<p align="center"><a href="https://github.com/krsnzd/license/">🕉</a></p>