mobiledoc-dom-renderer

Mobiledoc DOM Renderer

This is a DOM renderer for the Mobiledoc format used by Mobiledoc-Kit.

The renderer is a small library intended for use in browser clients.

Usage

var mobiledoc = {
  version: "0.2.0",
  sections: [
    [         // markers
      ['B']
    ],
    [         // sections
      [1, 'P', [ // array of markups
        // markup
        [
          [0],          // open markers (by index)
          0,            // close count
          'hello world'
        ]
      ]
    ]
  ]
};
var renderer = new MobiledocDOMRenderer({cards: []});
var rendered = renderer.render(mobiledoc);
var result = rendered.result;
document.getElementById('output').appendChild(result);
// renders <div><p><b>hello world</b></b></div>
// into 'output' element

The Renderer constructor accepts a single object with the following optional properties:

• cards: An array of card objects
• cardOptions: Options to pass to cards when they are rendered
• unknownCardHandler: A method that will be called when any unknown card is enountered

The return value from renderer.render(mobiledoc) is an object with two properties:

• result The rendered result. A DOMNode
• teardown A teardown method that, when called, will tear down the rendered mobiledoc and call any teardown handlers that were registered by cards in the mobiledoc.

Tests

• npm test

Releasing

• npm version patch or minor or major
• npm run build
• npm run update-changelog
• git push bustle --tags
• npm publish

Changelog

0.2.0 (2015-11-23)

• 0.2.0 (5849616)
• refactor to handle new cards (e6fd6fd), closes #17
• Update changelog (7f942c6)

<a name="0.1.18"></a>