Liking cljdoc? Tell your friends :D

baremirror.alpha.js

The functions for JavaScript. JavaScript values go in and come out: a template is an array, attributes and containers are objects, and a hole is a function.

The functions for JavaScript. JavaScript values go in and come out: a template is an array,
attributes and containers are objects, and a hole is a function.
raw docstring

define-elementcljs

(define-element tag options)

Registers tag as an element with no state, from an object with attrs, template and css.

Registers `tag` as an element with no state, from an object with `attrs`, `template` and `css`.
sourceraw docstring

dispatchercljs

(dispatcher store step view render)

A function of a message. It puts step(store.value, message) into store.value, renders the view of what store then holds, and returns the new state.

A function of a message. It puts `step(store.value, message)` into `store.value`, renders the
view of what `store` then holds, and returns the new state.
sourceraw docstring

listencljs

(listen root options)

Adds the listeners of options to root: dispatch, a function of a message, events, pairs of an event type with a part name and a meaning, and requests, an object from an event type to the attributes it asks to change.

Adds the listeners of `options` to `root`: `dispatch`, a function of a message, `events`,
pairs of an event type with a part name and a meaning, and `requests`, an object from an event
type to the attributes it asks to change.
sourceraw docstring

make-nodecljs

(make-node array)

Makes one detached HTML element from the fixed template array.

Makes one detached HTML element from the fixed template `array`.
sourceraw docstring

performcljs

(perform reading steps make)

Performs the plan steps on what read-places returned, with make making the node of a new key. Returns an object of key to node.

Performs the plan `steps` on what `read-places` returned, with `make` making the node of a
new key. Returns an object of key to node.
sourceraw docstring

plancljs

(plan current wanted)

What must happen to turn the current places into the wanted places: an object with remove, the keys, and place, objects of key, in and before.

What must happen to turn the `current` places into the `wanted` places: an object with
`remove`, the keys, and `place`, objects of `key`, `in` and `before`.
sourceraw docstring

read-origincljs

(read-origin e)

The origin of the event e: an object with keyPath, part and node.

The origin of the event `e`: an object with `keyPath`, `part` and `node`.
sourceraw docstring

read-partscljs

(read-parts node)

The parts of node as an object of part name to node.

The parts of `node` as an object of part name to node.
sourceraw docstring

read-placescljs

(read-places containers)

The current places of containers, with the node of each key: an object with containers, places and nodes.

The current places of `containers`, with the node of each key: an object with `containers`,
`places` and `nodes`.
sourceraw docstring

releasecljs

(release node)

Gives node up: it keeps its place in the document and loses its key.

Gives `node` up: it keeps its place in the document and loses its key.
sourceraw docstring

set-attrscljs

(set-attrs el attrs)

Brings the attributes of el that the object attrs names to their values.

Brings the attributes of `el` that the object `attrs` names to their values.
sourceraw docstring

set-textcljs

(set-text el text)

Makes text the whole content of el, and writes only where it differs.

Makes `text` the whole content of `el`, and writes only where it differs.
sourceraw docstring

split-templatecljs

(split-template template-name array)

Splits the template array. Returns a frozen object with fixed, holes, events as pairs of an event type with a part name and a meaning, and writes, a function of an item.

Splits the template `array`. Returns a frozen object with `fixed`, `holes`, `events` as pairs
of an event type with a part name and a meaning, and `writes`, a function of an item.
sourceraw docstring

sync-placescljs

(sync-places containers wanted make)

Brings containers to the wanted places, with make making the node of a new key. Returns an object of key to node.

Brings `containers` to the `wanted` places, with `make` making the node of a new key.
Returns an object of key to node.
sourceraw docstring

with-one-rendercljs

(with-one-render el f)

Calls f with el while el holds its attribute changes, when it offers that.

Calls `f` with `el` while `el` holds its attribute changes, when it offers that.
sourceraw docstring

write-partscljs

(write-parts parts writes)

Applies the object writes to the object parts, both by part name.

Applies the object `writes` to the object `parts`, both by part name.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close