6.0 KiB
markup, title, description, import
| markup | title | description | import | ||
|---|---|---|---|---|---|
| occlusion | lib/browser | Readable browser effect helpers for WASM clients. Prefer GFM tables + these helpers; do not build effects with json.set chains. |
|
Readable browser effect helpers for WASM clients. Prefer GFM tables + these helpers; do not build effects with json.set chains.
set_text
+ `sel`
+ `text`
Build set_text effect map for the official bridge.
m = > table.put in=None at=sel value=text
> table.put in=None at="set_text" value=m
set_html
+ `sel`
+ `html`
Build set_html effect map.
m = > table.put in=None at=sel value=html
> table.put in=None at="set_html" value=m
set_value
+ `sel`
+ `value`
Build set_value effect map.
m = > table.put in=None at=sel value=value
> table.put in=None at="set_value" value=m
set_class
+ `sel`
+ `class`
Build set_class effect map.
m = > table.put in=None at=sel value=class
> table.put in=None at="set_class" value=m
add_class
+ `sel`
+ `class`
Build add_class effect map (classList.add; space-separated names OK).
m = > table.put in=None at=sel value=class
> table.put in=None at="add_class" value=m
remove_class
+ `sel`
+ `class`
Build remove_class effect map.
m = > table.put in=None at=sel value=class
> table.put in=None at="remove_class" value=m
toggle_class
+ `sel`
+ `class`
Build toggle_class effect map.
m = > table.put in=None at=sel value=class
> table.put in=None at="toggle_class" value=m
set_style
+ `sel`
+ `style`
Build set_style effect map; style is a map of CSS properties or a cssText string.
m = > table.put in=None at=sel value=style
> table.put in=None at="set_style" value=m
set_attr
+ `sel`
+ `attrs`
Build set_attr effect map; attrs is usually a small map of attribute names to values.
m = > table.put in=None at=sel value=attrs
> table.put in=None at="set_attr" value=m
wrap
+ `key`
+ `value`
Single-key effect map wrapper.
> table.put in=None at=key value=value
merge
+ `a`
+ `b`
Merge two effect maps; right-hand keys win.
> table.merge a=a b=b
canvas
+ `sel`
+ `commands`
+ `clear`=True
Build canvas effect; commands is usually an @ GFM table.
spec =
| sel | clear | commands |
|---|---|---|
sel |
clear |
commands |
> table.put in=None at="canvas" value=spec
audio
+ `op`="play"
+ `id`="default"
+ `src`=""
+ `freq`=None
+ `ms`=None
+ `sel`=""
Build audio effect for the bridge.
spec = > table.put in=None at="op" value=op
spec = > table.put in=spec at="id" value=id
src!= ""spec= > table.put in=specat="src" value=srcfreq!= Nonespec= > table.put in=specat="freq" value=freqms!= Nonespec= > table.put in=specat="ms" value=mssel!= ""spec= > table.put in=specat="sel" value=sel > table.put in=None at="audio" value=spec
read_file
+ `sel`
+ `then`
+ `as`="text"
Build read_file effect.
spec =
| sel | as | then |
|---|---|---|
sel |
as |
then |
> table.put in=None at="read_file" value=spec
observe
+ `specs`
Build observe effect; specs is one map or an @ list of maps.
> table.put in=None at="observe" value=specs
unobserve
+ `specs`
Build unobserve effect; specs is a map or @ list with id.
> table.put in=None at="unobserve" value=specs
focus
+ `sel`
focus.
> table.put in=None at="focus" value=sel
navigate
+ `url`
+ `replace`=False
spec =
| url | replace |
|---|---|
url |
replace |
> table.put in=None at="navigate" value=spec
store_set
+ `key`
+ `value`
+ `scope`="memory"
+ `then`=""
In-memory (or local/session) key write for SPA client state. Prefer scope=memory for tab-local app state.
Optional then is called after the write with {ok, op, key, scope}.
spec =
| op | key | value | scope |
|---|---|---|---|
| set | key |
value |
scope |
then!= ""spec= > table.put in=spec at="then" value=then > table.put in=None at="storage" value=spec
store_get
+ `key`
+ `then`
+ `scope`="memory"
Read a key then call then with {ok, value, found, key, scope}.
spec =
| op | key | then | scope |
|---|---|---|---|
| get | key |
then |
scope |
> table.put in=None at="storage" value=spec
spa_goto
+ `url`
+ `replace`=False
SPA navigation: history.pushState / replaceState via bridge navigate effect.
spec =
| url | replace |
|---|---|
url |
replace |
> table.put in=None at="navigate" value=spec
storage
+ `spec`
storage.
> table.put in=None at="storage" value=spec
interval
+ `ms`
+ `then`
+ `id`="default"
spec =
| ms | then | id |
|---|---|---|
ms |
then |
id |
> table.put in=None at="interval" value=spec
clear_interval
+ `id`="default"
clear_interval.
spec = > table.put in=None at="id" value=id
> table.put in=None at="clear_interval" value=spec
fetch
+ `url`
+ `then`
+ `method`="GET"
spec =
| url | then | method |
|---|---|---|
url |
then |
method |
> table.put in=None at="fetch" value=spec
fetch_all
+ `requests`
+ `then`
spec =
| requests | then |
|---|---|
requests |
then |
> table.put in=None at="fetch_all" value=spec
after
+ `ms`
+ `then`
spec =
| ms | then |
|---|---|
ms |
then |
> table.put in=None at="after" value=spec
ws
+ `spec`
ws.
> table.put in=None at="ws" value=spec
clipboard
+ `text`
clipboard.
spec = > table.put in=None at="text" value=text
> table.put in=None at="clipboard" value=spec
download
+ `body`
+ `filename`="download.txt"
+ `mime`="text/plain;charset=utf-8"
spec =
| body | filename | mime |
|---|---|---|
body |
filename |
mime |
> table.put in=None at="download" value=spec