Neverending Perpetual Motion
    Have ideas to improve npm?Join in the discussion! »

    riotify-fn

    0.3.0 • Public • Published

    riotify-fn

    riotify-fn is a browserify transform for Riot.js, to include .tag files as constructor functions.

    It's a way to use .tag files as precompiled templates, which leaves the initialization to the consumer.

    What's the difference with riotify?

    • With riotify, requiring a .tag file initializes the tag and returns its name.
    • With riotify-fn, requiring a .tag file returns a constructor function. It is then used to initialize the tag with given methods and properties.

    How does it work?

    riotify-fn compiles .tag files with the entities option (new in Riot v2.3.12), which transforms them to raw tag parts. It returns a constructor function that extends and builds the tag using riot.tag(). Since the tag is precompiled, all template features like self-closing tags are supported.

    Install

    $ npm i riotify-fn --save-dev

    Apply transform

    In command line

    $ browserify -t riotify-fn

    ..or package.json

    "browserify"{
      "transform": [ "riotify-fn" ]
    }

    ..or gulp task

    browserify({
      transform: [ 'riotify-fn' ]
    });

    Transform options

    ext - an object mapping file extension (key) to transform mode (value)

    Available modes are:

    • fn returns constructor function (default)
    • tag returns constructed tag name (same as riotify)
    • obj returns an array of raw tag entities

    Default setting is { tag: 'fn' }.

    The example below will compile .tag files the same as riotify, and export .riot files as contructor functions.

    browserify({
      transform: [
        ['riotify-fn', {
          ext: { tag: 'tag', riot: 'fn' }
        }]
      ]
    });

    Include the tag

    Here is an example .tag file.

    <my-button>
      <button onclick={clicked}>{label}</button>
    </my-button>

    When required, it returns a constructor function.

    var makeButton = require('./my-button.tag');

    Constructor

    The constructor will build all tags defined in the file.

    Given no argument, it is equivalent to requiring the tag using riotify.

    makeButton();

    It takes an optional argument of a function or object to extend the tag. If multiple tags are defined in the .tag file, the first tag is extended.

    Given a function, it will be used to instantiate the tag in place of any script in the tag file.

    makeButton(function() {
      this.label = 'Hi';
      this.super();
    });

    this is the tag instance. this.super is a function that runs the default script from the tag file, if there were any; otherwise it does nothing.

    Given an object, its properties are assigned to the tag instance.

    makeButton({
      label: 'Hi',
      clicked: function() {
        this.label = 'Bye';
      }
    });

    Optionally, set:

    • tagName to give a new tag name
    • init as the initial function. It works the same as the function argument above. If init is not set, the default script in the tag file is used to instantiate the tag.

    Result

    After the constructor is done, it returns the tag name. This can be used to mount it, if needed.

    riot.mount(makeButton());

    Future ideas

    • Transform mode: JSX, ES6 classes?

    Credit

    riotify-fn is based on riotify

    Install

    npm i riotify-fn

    DownloadsWeekly Downloads

    1

    Version

    0.3.0

    License

    MIT

    Last publish

    Collaborators

    • avatar