tylors / cycle-snabbdom

Alternative DOM driver utilizing the snabbdom library

cycle-snabbdom

Deprecation

It's been great, and thank you for using this library :) @cycle/dom is likely reached it's last release candidate, and will be released soon! This library is at 100% parity with it, and is actually a slight step ahead as it has updated to the latest snabbdom 0.5.0 in the process. However, this will be the very last update this library will see. I strongly urge you to start updating your application to Cycle.js Diversity as soon as you can, and to stop using Rx ;)

Alternative DOM driver utilizing the snabbdom library

Install

$ npm install cycle-snabbdom

API

makeDOMDriver(container: string|Element, {modules?: Array})

import {makeDOMDriver} from 'cycle-snabbdom'

makeHTMLDriver()

import {makeHTMLDriver} from 'cycle-snabbdom'

h - thunk - hyperscript-helpers

Shorcuts to snabbdom/h, snabbdom/thunk and hyperscript-helpers

import {h, thunk, div, span, h4} from 'cycle-snabbdom'

modules : Array

Shortcut to snabbdom modules.

import Cycle from '@cycle/core'
import {modules, makeDOMDriver} from 'cycle-snabbdom'
const {
  StyleModule, PropsModule,
  AttrsModule, ClassModule,
  HeroModule, EventsModule,
} = modules
...

Cycle.run(main, {
  DOM: makeDOMDriver('#app', {modules: [
    StyleModule, PropsModule,
    AttrsModule, ClassModule,
    HeroModule, EventsModule
  ]})
})

mockDOMSource()

A testing utility which aids in creating a queryable collection of Observables. Call mockDOMSource giving it an object specifying selectors, eventTypes and their Observables, and get as output an object following the same format as the DOM Driver's source.

Example:

const userEvents = mockDOMSource({
 '.foo': {
   'click': Rx.Observable.just({target: {}}),
   'mouseover': Rx.Observable.just({target: {}})
 },
 '.bar': {
   'scroll': Rx.Observable.just({target: {}})
 }
});

// Usage
const click$ = userEvents.select('.foo').events('click');

Arguments:

mockedSelectors :: Object an object where keys are selector strings and values are objects. Those nested objects have eventType strings as keys and values are Observables you created. Return:

(Object) fake DOM source object, containing a function select() which can be used just like the DOM Driver's source. Call select(selector).events(eventType) on the source object to get the Observable you defined in the input of mockDOMSource.