vdo

    4.2.0 • Public • Published

    js-standard-style npm

    VDO

    The lightweight JSX compatible templating engine. Perfect for creating html strings server side or in browser.

    Check out set-dom, diffhtml or morphdom for React style diffing.

    Why

    JSX is powerful compared to other templating engines but it has some warts. It has some abstractions that simply don't make sense for creating html (ala className). "VDO" provides a JSX interface that is specifically designed for rendering html, not DOM.

    Features

    • Minimal API.
    • ~1kb min/gzip.
    • No extra "data-react-id".
    • No random span's.
    • Allows any custom attribute (react only allows data-).
    • Render nested arrays.
    • Optimized for rendering html.
    • Escaped values by default.
    • JSX compatible.

    Installation

    Npm

    npm install vdo

    Example

    /** @jsx vdo */
    const vdo = require('vdo');
     
    function MyPartial (attrs, children) {
        return <span class="custom" data-value={attrs.value}/>;
    }
     
    const html = (
        <div class="root">
            <MyPartial value="1"/>
        </div>
    );
     
    document.body.innerHTML = html;
     

    API

    • isElement(element) : Tests if given element is a vdo virtual element.
    vdo.isElement(<div/>); // true
    • markSafe(html) : Marks html as safe as a VDO child node.
    // Use #markSafe instead of "innerHTML" when coming from react.
    // This allows for mixes of safe and unsafe html in the same node.
    const myHTMLStr = "<br/>";
    const vNode = <div>{ vdo.markSafe(myHTMLStr) }</div>;
    String(vNode); //-> <div><br/></div>
    • with(context, renderer) : Gives all components inside a render function some external context.
    // renderer must be a function that returns a virtual node.
    function MyComponent (props, children, context) {
        return (
            <div>External data: { context }</div>
        );
    }
     
    String(vdo.with(1, ()=> <MyComponent/>));
    //-> "<div>External Data: 1</div>"
    • createElement(type, props, children...) : Create a virtual node/component.
    // Automatically called when using JSX.
    let vNode = vdo.createElement("div", { editable: true }, "Hello World");
    // Or call vdo directly
    let vNode = vdo("div", { editable: true }, "Hello World");
     
    // Render to string on the server.
    vNode.toString(); // '<div editable="true">Hello World</div>';
     
    /**
     * @params type can also be a function (shown in example above).
     */

    Contributions

    • Use npm test to run tests.

    Please feel free to create a PR!

    Install

    npm i vdo

    DownloadsWeekly Downloads

    1

    Version

    4.2.0

    License

    MIT

    Last publish

    Collaborators

    • dylanpiercey