api documentation for riot (v3.4.3)

A React-like user interface micro-library

table of contents

  1. module riot
    1. function riot.Tag (el, opts)
    2. function riot.compile (src, opts, url)
    3. function riot.mixin (name, mix, g)
    4. function riot.mount (selector, tagName, opts)
    5. function riot.observable (el)
    6. function riot.render (tagName, opts)
    7. function riot.renderAsync (tagName, opts)
    8. function riot.require (filename, opts)
    9. function riot.tag (name, tmpl, css, attrs, fn)
    10. function riot.tag2 (name, tmpl, css, attrs, fn)
    11. function riot.unregister (name)
    12. function riot.update ()
    13. function riot.util.brackets (reOrIdx)
    14. function riot.util.tmpl (str, data)
    15. object riot
    16. object riot.parsers
    17. object riot.parsers.css
    18. object riot.parsers.html
    19. object riot.parsers.js
    20. object riot.riot_compiler
    21. object riot.riot_csp
    22. object riot.sdom
    23. object riot.settings
    24. object riot.util
    25. object riot.util.check
    26. object riot.util.dom
    27. object riot.util.misc
    28. object riot.util.styleManager
    29. object riot.util.tags
    30. string riot.version
  2. module riot.parsers
    1. function riot.parsers._req (name, req)
    2. object riot.parsers.css
    3. object riot.parsers.html
    4. object riot.parsers.js
  3. module riot.parsers.css
    1. function riot.parsers.css.less (p1, p2, p3, p4)
    2. function riot.parsers.css.sass (p1, p2, p3, p4)
    3. function riot.parsers.css.scss (p1, p2, p3, p4)
    4. function riot.parsers.css.stylus (p1, p2, p3, p4)
  4. module riot.parsers.html
    1. function riot.parsers.html.jade (p1, p2, p3, p4)
    2. function riot.parsers.html.pug (p1, p2, p3, p4)
  5. module riot.parsers.js
    1. function riot.parsers.js.buble (p1, p2, p3, p4)
    2. function riot.parsers.js.coffee (p1, p2, p3, p4)
    3. function riot.parsers.js.coffeescript (p1, p2, p3, p4)
    4. function riot.parsers.js.es6 (p1, p2, p3, p4)
    5. function riot.parsers.js.javascript (src)
    6. function riot.parsers.js.livescript (p1, p2, p3, p4)
    7. function riot.parsers.js.none (src)
    8. function riot.parsers.js.typescript (p1, p2, p3, p4)
  6. module riot.render
    1. function riot.render (tagName, opts)
    2. function riot.render.dom (tagName, opts)
    3. function riot.render.tag (tagName, opts)
  7. module riot.riot
    1. function riot.riot.Tag (el, opts)
    2. function riot.riot.compile (src, opts, url)
    3. function riot.riot.mixin (name, mix, g)
    4. function riot.riot.mount (selector, tagName, opts)
    5. function riot.riot.observable (el)
    6. function riot.riot.render (tagName, opts)
    7. function riot.riot.renderAsync (tagName, opts)
    8. function riot.riot.require (filename, opts)
    9. function riot.riot.tag (name, tmpl, css, attrs, fn)
    10. function riot.riot.tag2 (name, tmpl, css, attrs, fn)
    11. function riot.riot.unregister (name)
    12. function riot.riot.update ()
    13. object riot.riot.parsers
    14. object riot.riot.settings
    15. object riot.riot.util
    16. string riot.riot.version
  8. module riot.riot_compiler
    1. function riot.riot_compiler.Tag (el, opts)
    2. function riot.riot_compiler.compile (arg, fn, opts)
    3. function riot.riot_compiler.mixin (name, mix, g)
    4. function riot.riot_compiler.mount ()
    5. function riot.riot_compiler.observable (el)
    6. function riot.riot_compiler.tag (name, tmpl, css, attrs, fn)
    7. function riot.riot_compiler.tag2 (name, tmpl, css, attrs, fn)
    8. function riot.riot_compiler.unregister (name)
    9. function riot.riot_compiler.update ()
    10. object riot.riot_compiler.default
    11. object riot.riot_compiler.parsers
    12. object riot.riot_compiler.settings
    13. object riot.riot_compiler.util
    14. string riot.riot_compiler.version
  9. module riot.riot_csp
    1. function riot.riot_csp.Tag (el, opts)
    2. function riot.riot_csp.mixin (name, mix, g)
    3. function riot.riot_csp.mount (selector, tagName, opts)
    4. function riot.riot_csp.observable (el)
    5. function riot.riot_csp.tag (name, tmpl, css, attrs, fn)
    6. function riot.riot_csp.tag2 (name, tmpl, css, attrs, fn)
    7. function riot.riot_csp.unregister (name)
    8. function riot.riot_csp.update ()
    9. object riot.riot_csp.default
    10. object riot.riot_csp.settings
    11. object riot.riot_csp.util
    12. string riot.riot_csp.version
  10. module riot.sdom
    1. function riot.sdom.parse (html)
    2. function riot.sdom.serialize (doc)
  11. module riot.util
    1. function riot.util.brackets (reOrIdx)
    2. function riot.util.tmpl (str, data)
    3. object riot.util.check
    4. object riot.util.dom
    5. object riot.util.misc
    6. object riot.util.styleManager
    7. object riot.util.tags
    8. object riot.util.vdom
  12. module riot.util.brackets
    1. function riot.util.brackets (reOrIdx)
    2. function riot.util.brackets.array (pair)
    3. function riot.util.brackets.hasExpr (str)
    4. function riot.util.brackets.loopKeys (expr)
    5. function riot.util.brackets.set (pair)
    6. function riot.util.brackets.split (str, tmpl, _bp)
    7. object riot.util.brackets.R_MLCOMMS
    8. object riot.util.brackets.R_STRINGS
    9. string riot.util.brackets.S_QBLOCKS
    10. string riot.util.brackets.version
  13. module riot.util.check
    1. function riot.util.check.isArray (value)
    2. function riot.util.check.isBlank (value)
    3. function riot.util.check.isBoolAttr (value)
    4. function riot.util.check.isFunction (value)
    5. function riot.util.check.isObject (value)
    6. function riot.util.check.isReservedName (value)
    7. function riot.util.check.isString (value)
    8. function riot.util.check.isUndefined (value)
    9. function riot.util.check.isWritable (obj, key)
  14. module riot.util.dom
    1. function riot.util.dom.createDOMPlaceholder ()
    2. function riot.util.dom.createFrag ()
    3. function riot.util.dom.getAttr (dom, name)
    4. function riot.util.dom.mkEl (name)
    5. function riot.util.dom.remAttr (dom, name)
    6. function riot.util.dom.safeInsert (root, curr, next)
    7. function riot.util.dom.setAttr (dom, name, val)
    8. function riot.util.dom.setInnerHTML (container, html)
    9. function riot.util.dom.styleObjectToString (style)
    10. function riot.util.dom.toggleVisibility (dom, show)
    11. function riot.util.dom.walkAttrs (html, fn)
    12. function riot.util.dom.walkNodes (dom, fn, context)
  15. module riot.util.misc
    1. function riot.util.misc.contains (array, item)
    2. function riot.util.misc.defineProperty (el, key, value, options)
    3. function riot.util.misc.each (list, fn)
    4. function riot.util.misc.extend (src)
    5. function riot.util.misc.startsWith (str, value)
    6. function riot.util.misc.toCamel (str)
  16. module riot.util.styleManager
    1. function riot.util.styleManager.add (css, name)
    2. function riot.util.styleManager.inject ()
  17. module riot.util.tags
    1. function riot.util.tags.arrayishAdd (obj, key, value, ensureArray, index)
    2. function riot.util.tags.arrayishRemove (obj, key, value, ensureArray)
    3. function riot.util.tags.cleanUpData (data)
    4. function riot.util.tags.getImmediateCustomParentTag (tag)
    5. function riot.util.tags.getTag (dom)
    6. function riot.util.tags.getTagName (dom, skipDataIs)
    7. function riot.util.tags.inheritFrom (target, propsInSyncWithParent)
    8. function riot.util.tags.initChildTag (child, opts, innerHTML, parent)
    9. function riot.util.tags.makeReplaceVirtual (tag, ref)
    10. function riot.util.tags.makeVirtual (src, target)
    11. function riot.util.tags.mountTo (root, tagName, opts, ctx)
    12. function riot.util.tags.moveChildTag (tagName, newPos)
    13. function riot.util.tags.moveVirtual (src, target)
    14. function riot.util.tags.selectTags (tags)
    15. function riot.util.tags.unmountAll (expressions)
  18. module riot.util.tmpl
    1. function riot.util.tmpl (str, data)
    2. function riot.util.tmpl.clearCache ()
    3. function riot.util.tmpl.hasExpr (str)
    4. function riot.util.tmpl.loopKeys (expr)
    5. object riot.util.tmpl.errorHandler
    6. string riot.util.tmpl.version

module riot

function riot.Tag (el, opts)

function riot.compile (src, opts, url)

function riot.mixin (name, mix, g)

function riot.mount (selector, tagName, opts)

function riot.observable (el)

function riot.render (tagName, opts)

function riot.renderAsync (tagName, opts)

function riot.require (filename, opts)

function riot.tag (name, tmpl, css, attrs, fn)

function riot.tag2 (name, tmpl, css, attrs, fn)

function riot.unregister (name)

function riot.update ()

function riot.util.brackets (reOrIdx)

function riot.util.tmpl (str, data)

module riot.parsers

function riot.parsers._req (name, req)

module riot.parsers.css

function riot.parsers.css.less (p1, p2, p3, p4)

function riot.parsers.css.sass (p1, p2, p3, p4)

function riot.parsers.css.scss (p1, p2, p3, p4)

function riot.parsers.css.stylus (p1, p2, p3, p4)

module riot.parsers.html

function riot.parsers.html.jade (p1, p2, p3, p4)

function riot.parsers.html.pug (p1, p2, p3, p4)

module riot.parsers.js

function riot.parsers.js.buble (p1, p2, p3, p4)

function riot.parsers.js.coffee (p1, p2, p3, p4)

function riot.parsers.js.coffeescript (p1, p2, p3, p4)

function riot.parsers.js.es6 (p1, p2, p3, p4)

function riot.parsers.js.javascript (src)

function riot.parsers.js.livescript (p1, p2, p3, p4)

function riot.parsers.js.none (src)

function riot.parsers.js.typescript (p1, p2, p3, p4)

module riot.render

function riot.render (tagName, opts)

function riot.render.dom (tagName, opts)

function riot.render.tag (tagName, opts)

module riot.riot

function riot.riot.Tag (el, opts)

function riot.riot.compile (src, opts, url)

function riot.riot.mixin (name, mix, g)

function riot.riot.mount (selector, tagName, opts)

function riot.riot.observable (el)

function riot.riot.render (tagName, opts)

function riot.riot.renderAsync (tagName, opts)

function riot.riot.require (filename, opts)

function riot.riot.tag (name, tmpl, css, attrs, fn)

function riot.riot.tag2 (name, tmpl, css, attrs, fn)

function riot.riot.unregister (name)

function riot.riot.update ()

module riot.riot_compiler

function riot.riot_compiler.Tag (el, opts)

function riot.riot_compiler.compile (arg, fn, opts)

function riot.riot_compiler.mixin (name, mix, g)

function riot.riot_compiler.mount ()

function riot.riot_compiler.observable (el)

function riot.riot_compiler.tag (name, tmpl, css, attrs, fn)

function riot.riot_compiler.tag2 (name, tmpl, css, attrs, fn)

function riot.riot_compiler.unregister (name)

function riot.riot_compiler.update ()

module riot.riot_csp

function riot.riot_csp.Tag (el, opts)

function riot.riot_csp.mixin (name, mix, g)

function riot.riot_csp.mount (selector, tagName, opts)

function riot.riot_csp.observable (el)

function riot.riot_csp.tag (name, tmpl, css, attrs, fn)

function riot.riot_csp.tag2 (name, tmpl, css, attrs, fn)

function riot.riot_csp.unregister (name)

function riot.riot_csp.update ()

module riot.sdom

function riot.sdom.parse (html)

function riot.sdom.serialize (doc)

module riot.util

function riot.util.brackets (reOrIdx)

function riot.util.tmpl (str, data)

module riot.util.brackets

function riot.util.brackets (reOrIdx)

function riot.util.brackets.array (pair)

function riot.util.brackets.hasExpr (str)

function riot.util.brackets.loopKeys (expr)

function riot.util.brackets.set (pair)

function riot.util.brackets.split (str, tmpl, _bp)

module riot.util.check

function riot.util.check.isArray (value)

function riot.util.check.isBlank (value)

function riot.util.check.isBoolAttr (value)

function riot.util.check.isFunction (value)

function riot.util.check.isObject (value)

function riot.util.check.isReservedName (value)

function riot.util.check.isString (value)

function riot.util.check.isUndefined (value)

function riot.util.check.isWritable (obj, key)

module riot.util.dom

function riot.util.dom.createDOMPlaceholder ()

function riot.util.dom.createFrag ()

function riot.util.dom.getAttr (dom, name)

function riot.util.dom.mkEl (name)

function riot.util.dom.remAttr (dom, name)

function riot.util.dom.safeInsert (root, curr, next)

function riot.util.dom.setAttr (dom, name, val)

function riot.util.dom.setInnerHTML (container, html)

function riot.util.dom.styleObjectToString (style)

function riot.util.dom.toggleVisibility (dom, show)

function riot.util.dom.walkAttrs (html, fn)

function riot.util.dom.walkNodes (dom, fn, context)

module riot.util.misc

function riot.util.misc.contains (array, item)

function riot.util.misc.defineProperty (el, key, value, options)

function riot.util.misc.each (list, fn)

function riot.util.misc.extend (src)

function riot.util.misc.startsWith (str, value)

function riot.util.misc.toCamel (str)

module riot.util.styleManager

function riot.util.styleManager.add (css, name)

function riot.util.styleManager.inject ()

module riot.util.tags

function riot.util.tags.arrayishAdd (obj, key, value, ensureArray, index)

function riot.util.tags.arrayishRemove (obj, key, value, ensureArray)

function riot.util.tags.cleanUpData (data)

function riot.util.tags.getImmediateCustomParentTag (tag)

function riot.util.tags.getTag (dom)

function riot.util.tags.getTagName (dom, skipDataIs)

function riot.util.tags.inheritFrom (target, propsInSyncWithParent)

function riot.util.tags.initChildTag (child, opts, innerHTML, parent)

function riot.util.tags.makeReplaceVirtual (tag, ref)

function riot.util.tags.makeVirtual (src, target)

function riot.util.tags.mountTo (root, tagName, opts, ctx)

function riot.util.tags.moveChildTag (tagName, newPos)

function riot.util.tags.moveVirtual (src, target)

function riot.util.tags.selectTags (tags)

function riot.util.tags.unmountAll (expressions)

module riot.util.tmpl

function riot.util.tmpl (str, data)

function riot.util.tmpl.clearCache ()

function riot.util.tmpl.hasExpr (str)

function riot.util.tmpl.loopKeys (expr)

[ this document was created with utility2 ]