Nonchalant Programming Master

    @bustle/mobiledoc-facebook-instant-renderer

    0.2.0 • Public • Published

    Mobiledoc Facebook Instant Renderer Build Status

    This is a Facebook Instant Article renderer for the Mobiledoc format used by Mobiledoc-Kit.

    Learn about Facebook Instant here.

    To learn more about Mobiledoc cards and renderers, see the Mobiledoc Cards docs.

    The renderer is a small library intended for use in servers that are building Facebook Instant documents.

    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 MobiledocFacebookInstantRenderer({cards: []});
    var rendered = renderer.render(mobiledoc);
    console.log(rendered.result.outerHTML); // "<p><b>hello world</b></p>"
    

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

    • cards [array] - The list of card objects that the renderer may encounter in the mobiledoc
    • atoms [array] - The list of atom objects that the renderer may encounter in the mobiledoc
    • cardOptions [object] - Options to pass to cards and atoms when they are rendered
    • unknownCardHandler [function] - Will be called when any unknown card is enountered
    • unknownAtomHandler [function] - Will be called when any unknown atom is enountered
    • sectionElementRenderer [object] - A map of hooks for section element rendering.
      • Valid keys are P, H1, H2, H3, BLOCKQUOTE, PULL-QUOTE
      • The hooks is passed the document
      • A valid value is a function that returns an element

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

    • result [object] - The rendered result, a DOM node
    • teardown [function] - When called, this function will tear down the rendered mobiledoc and call any teardown handlers that were registered by cards when they were rendered

    sectionElementRenderer

    Use this renderer option to customize what element is used when rendering a section.

    var renderer = new MobiledocFacebookInstantRenderer({
      sectionElementRenderer: {
        P: function(dom) { return dom.createElement('span'); },
        H1: function(dom) { return dom.createElement('h2'); },
        H2: function(dom) {
          var element = dom.createElement('h2');
          element.setAttribute('class', 'subheadline');
          return element;
        }
        /* Valid keys are P, H1, H2, H3, BLOCKQUOTE, PULL-QUOTE */
      }
    });
    var rendered = renderer.render(mobiledoc);
    

    Tests

    Command-line:

    • npm test

    Or in the browser:

    Releasing

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

    Install

    npm i @bustle/mobiledoc-facebook-instant-renderer

    DownloadsWeekly Downloads

    9

    Version

    0.2.0

    License

    MIT

    Last publish

    Collaborators

    • eggplantkiller
    • tholman
    • teety
    • tylerlove
    • zeejab
    • tsiege
    • anujpan
    • gdub
    • mixonic
    • bantic
    • bustle-deploy
    • zfoster
    • janecakemaster
    • redterror
    • chris-olszewski
    • hichaelmart
    • ensallee
    • wabyad
    • sarahganis
    • thinko
    • awongs
    • cg3ntry