baredom.components.x-toc.model — com.github.avanelsas/baredom 4.15.0

active-index cljs

(active-index tops line at-bottom?)

The index of the active entry. tops holds the top of each entry from the top of the scroll root, line the activation line. Nil when there are no entries.

attr-for cljs

attr-id cljs

attr-label cljs

attr-offset cljs

attr-selector cljs

attr-sticky cljs

attr-tabindex cljs

attr-update-hash cljs

change-detail cljs

(change-detail {:keys [id text level index]} previous-id)

The detail of x-toc-change for a move from the entry previous-id to entry.

clean-text cljs

(clean-text s)

The text s trimmed, with each run of whitespace made one space.

default-label cljs

default-offset cljs

default-selector cljs

entries cljs

(entries identified)

The entries {:id :text :level :index} of the identified headings. A heading whose id an earlier one has is left out.

event-change cljs

event-navigate cljs

event-schema cljs

fallback-slug cljs

foreign-writes cljs

The attributes x-toc writes on the entries of its container.

heading-level cljs

(heading-level tag-name-text)

The level of the tag tag-name-text: 1 to 6 for H1 to H6, else nil.

id-writes cljs

(id-writes identified)

The [at id] pairs of the identified headings that need their id written.

identify cljs

(identify headings taken)

The headings with text, each with its id, its place :at in headings, and :new-id?. A heading is {:id :text :tag}, and taken holds the ids already in the root.

method-api cljs

navigate-detail cljs

(navigate-detail {:keys [id text level index]})

The detail of x-toc-navigate for entry.

next-pin cljs

(next-pin pin [kind id])

The pin after event: [:click id], [:scroll] or [:settle]. A pin holds the clicked entry until its scroll settles and the reader scrolls again.

normalize cljs

(normalize {:keys [for-raw selector-raw label-raw offset-raw update-hash?]})

The view model {:for :selector :label :labelled? :offset :update-hash?} from the raw attributes, without its entries.

observed-attributes cljs

offset-px cljs

(offset-px {:keys [unit value]} height)

The distance in px of the activation line from the top of a scroll root height px tall.

parse-offset cljs

(parse-offset s)

The offset {:unit :px|:percent :value n} that s states, or the default 25%.

parse-selector cljs

(parse-selector s)

The selector s, or the default for a blank one.

property-api cljs

slug cljs

(slug s)

An id made from the text s: lower case, letters and digits joined by -.

tag-name cljs