Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 1.23 KB

README.md

File metadata and controls

47 lines (26 loc) · 1.23 KB

knockout-state-renderer

npm version

Use Knockout with abstract-state-router!

Examples

Usage

var StateRouter = require('abstract-state-router')
var knockoutRenderer = require('knockout-state-renderer')
var domready = require('domready')

var stateRouter = StateRouter(knockoutRenderer(/* options */), 'body')

// add whatever states to the state router

domready(function() {
    stateRouter.evaluateCurrentRoute('login')
})

See state-router-example for an implementation using this renderer.

API

The renderer implementation accepts some options to control data binding inside the templates.

dataItemAlias

An alias used when the binding context is created, accessible inside the templates. The default value is $page.

childElementSelector

The CSS selector used to find the element where the child state should be rendered. The default value is ui-view.