Getting Started  •  Options  •  API  •  Benchmark  •  Template Compiler  •  Server-Side-Rendering  •  Express Render Engine  •  Reactive  •  Hydration  •  Web Components (Shadow DOM)  •  Changelog

When you are coming from any previous version: Migration Guide 0.8.x

Benchmark:

• Stress Test Benchmark
• https://krausest.github.io/js-framework-benchmark/current.html

Mikado was getting so much positive feedback and also feature requests. Help keeping Mikado active by a personal donation.

Rendering has great impact on application performance, especially on mobile devices. Mikado takes templating performance to a new level and provides you keyed, non-keyed recycling and also reactive paradigm switchable out of the box. On top, it also provides a server-side-rendering approach on a top-notch performance level along full support for hydration to inject templates progressively within the client's runtime. Server and client are sharing the same template definitions simply written in HTML-like markup. The server side approach will also come with the fastest middleware render engine for Express you can get today. Packed with a smart routing feature for event delegation and full support for web components using the shadow dom, Mikado gives you everything you'll need to build realtime applications on a cutting edge performance level.

1. Get Latest
2. Feature Comparison: Mikado Light
3. Benchmark Ranking (Rendering Performance)
4. API Overview
5. Mikado Options
6. Getting Started (Basic Example)
7. Rules and Conventions
8. Advanced Example
9. Template Compiler
   • Reserved Keywords
   • Compiler Flags
   • Auto Naming
   • Prebuilt Cache
   • Watcher (Auto-Compile)
   • Runtime Compiler
10. Template Expressions
    • Value Insertion
    • JS Inline Code
    • Truthy Values
    • Escape Values (SSR)
    • HTML Contents
    • Sanitizer
    • Reactive Bindings
11. Routing & Event Delegation
    • Event Bubbling
    • Event Cache
    • Explicit Register Event Delegation
    • Control Native Events
    • Dispatch Routes
12. Recycling Modes:
    • Non-Keyed Recycling
    • Keyed Recycling
13. Views:
    • Create Views
    • Mount Views
    • Destroy Views
    • Render Templates
    • Create Components
    • Modify Views
    • Common View Helpers
    • Manipulate Views
14. DOM State Caching
    • State Caching Concept
    • DOM Cache Helpers
15. View State
16. Custom Callbacks
17. Static Templates
    • Once (One-time rendering)
18. Server-Side Rendering (SSR)
    • SSR-exclusive Mode
19. Express Render Engine
    • Custom Options
    • Render Views
20. Template Features:
    • Template Expressions
    • Includes
    • Loop Partials
    • Inline Loops
    • Conditional Template Structures
21. Reactive Features:
    • Reactive Properties (Proxy)
    • Reactive Array (Virtual NodeList)
    • Limitations
    • Strict-Proxy Mode
22. Template Pools
23. Hydration
24. Web Components (Shadow DOM)
25. Full Template Example
26. Best Practices
27. Concept of Shared Components
28. Custom Builds
    • Supported Build Flags

Do not use the "src" folder of this repo. It isn't meant to be used directly, instead it needs compilation. You can easily perform a custom build, but don't use the source folder for production. You will need at least any kind of compiler which resolve the compiler flags within the code. The "dist" folder is containing every version which you probably need (including unminified modules).

All debug versions are providing debug information through the console and gives you helpful advices on certain situations.

Bundles export all their features as static functions to the public class namespace "Mikado" e.g. Mikado.register().

The abbreviations used at the end of the filenames indicates:

• bundle All features included, Mikado is available on window.Mikado
• light Only basic features are included, Mikado is available on window.Mikado
• es5 bundle has support for EcmaScript5, Mikado is available on window.Mikado
• module bundle is a Javascript module, Mikado is available by import Mikado from "./mikado.bundle.module.min.js"
• min bundle is minified
• debug bundle has enabled debug mode (only for development purposes, do not use for production)

When using modules you can choose from 2 variants: mikado.xxx.module.min.js has all features bundled on the public class namespace e.g. Mikado.register(), whereas the folder /dist/module/ export most of the features as functions which needs to be imported explicitly by import { register } from "./dist/module/mikado.js".

Also, for each variant there exist:

1. A debug version for the development
2. A pre-compiled minified version for production

Load the bundle by a script tag:

<script src="dist/mikado.bundle.min.js"></script>
<script>
  // ... access Mikado
</script>

Install Mikado via NPM:

npm install mikado

The dist folder are located in node_modules/mikado/dist/.

Use the bundled version exported as a module:

<script>
    import Mikado from "./dist/mikado.bundle.module.min.js";
    // bundled access by e.g. Mikado.register()
</script>

Also, pre-compiled non-bundled production-ready modules are located in dist/module-min/.

<script>
    import Mikado, { register } from "./dist/module-min/mikado.js";
    // bundled access by Mikado.register isn't available
    // requires direct access by e.g. register()
</script>

You can also load modules via CDN:

<script>
    import Mikado from "https://unpkg.com/mikado@0.8.2/dist/module/mikado.js";
</script>

Loading modules via CDN commonly expects to build/bundle your app properly before distribution. Do not load them via CDN in production.

Run the benchmark (non-keyed recycle):
https://raw.githack.com/nextapps-de/mikado/bench/

Run the benchmark (keyed recycle):
https://raw.githack.com/nextapps-de/mikado/bench/#keyed

Run the benchmark (internal/data-driven):
https://raw.githack.com/nextapps-de/mikado/bench/#internal

The values represent operations per second, each benchmark task has to process a data array of 100 items. Higher values are better, except for memory (the sum of allocated memory during the whole test).

The index is a statistic rank with a maximum possible value of 100, that requires a library to be the best in each test category (regardless how much better). The score value is based on median factorization, here a score of 100 represents the statistical midfield.

Most of these methods are optional, you can just use view.render(data) to apply all changes automatically.

Constructor:

• new Mikado(template, <options>) : view
• new Mikado.Array(array) : observable

Instance properties:

• view.name readonly
• view.root readonly
• view.length readonly
• view.state readonly

Static properties (not included in mikado.light.js):

• Mikado.eventCache : boolean
• Mikado.eventBubble : boolean

Static methods:

• Mikado.once(root, template, <data>, <state>, <callback>)
• Mikado.register(template, <options>)
• Mikado.unregister(template)

Static methods (not included in mikado.light.js):

• Mikado.route(name, function, <options>)
• Mikado.listen(event, <options>)
• Mikado.unlisten(event)
• Mikado.dispatch(route, <target>, <event>)
• Mikado.escape(text) : string
• Mikado.sanitize(text) : string

Instance methods:

• view.mount(root, <hydrate>)
• view.render(<data>, <state>, <callback>)
• view.create(data, <state>, <index>) : node
• view.add(data, <state>, <position>)
• view.append(data, <state>, <position>)
• view.update(node | index, data, <state>)
• view.replace(node | index, data, <state>)
• view.remove(node, <count>)
• view.clear()
• view.node(index) : node
• view.index(node) : number
• view.flush()
• view.destroy()

Instance methods (not included in mikado.light.js):

• view.route(name, function, <options>)
• view.listen(event, <options>)
• view.unlisten(event)
• view.dispatch(name, <target>, <event>)

View manipulation helpers (optional, not included in mikado.light.js):

• view.move(node | index, position)
• view.shift(node | index, offset)
• view.up(node | index)
• view.down(node | index)
• view.first(node | index)
• view.last(node | index)
• view.before(node | index, node | index)
• view.after(node | index, node | index)
• view.swap(node | index, node | index)

Static DOM Cache helpers (optional, not included in mikado.light.js):

• Mikado.setText(node, text)

• Mikado.getText(node) : string

• Mikado.setHtml(node, html)

• Mikado.getHtml(node) : string

• Mikado.setClass(node, [classnames])

• Mikado.getClass(node) : [string]

• Mikado.addClass(node, classname)

• Mikado.addClass(node, [classnames])

• Mikado.hasClass(node, classname) : boolean

• Mikado.removeClass(node, classname)

• Mikado.removeClasses(node, [classnames])

• Mikado.toggleClass(node, classname, <state>)

• Mikado.toggleClasses(node, [classnames], <state>)

• Mikado.toggleClasses(node, {classname: state})

• Mikado.setStyle(node, property, value)

• Mikado.setStyles(node, {property: value})

• Mikado.getStyle(node, property) : string

• Mikado.setCss(node, css)

• Mikado.getCss(node) : string

• Mikado.setAttribute(node, attribute, value)

• Mikado.setAttribute(node, {attribute: value})

• Mikado.getAttribute(node, attribute) : string | null

• Mikado.hasAttribute(node, attribute) : boolean

• Mikado.removeAttribute(node, attribute)

• Mikado.removeAttribute(node, [attributes])

Observable constructor (optional, not included in mikado.light.js):

• new Mikado.Array(<array>) : observable

Observable array-like methods (optional, not included in mikado.light.js):

• observable.length : number
• observable.mount(view)
• observable.concat([object])
• observable.push(object)
• observable.splice : [Object]
• observable.pop : Object
• observable.shift : Object
• observable.unshift(object)
• observable.slice(<index>, <count>)
• observable.set([object])
• observable.sort(fn)
• observable.reverse()
• observable.swap(idx_a, idx_b)
• observable.map(fn)
• observable.filter(fn)
• observable.indexOf(object) : number
• observable.lastIndexOf(object) : number
• observable.forEach(fn)

Each Mikado instance, also named includes/partials can have their own options. Except inline partials always inherits the same options from its parent. For this reason you should prefer named includes over inlining in certain situations.

The Mikado Compiler requires Node.js to be installed. This is probably the simplest step in this guide.

Install Mikado from NPM (this will also install the compiler):

npm install mikado

Assume there is an array of data items to render (or just one item as an object):

const data = [{
    username: "User A",
    tweets: ["foo", "bar", "foobar"]
},{
    username: "User B",
    tweets: ["foo", "bar", "foobar"]
},{
    username: "User C",
    tweets: ["foo", "bar", "foobar"]
}];

Accordingly, a template tpl/partial/user.html might look like:

<table>
  <tr>
    <td>User:</td>
    <td>{{ data.username }}</td>
  </tr>
  <tr>
    <td>Tweets:</td>
    <td>{{ data.tweets.length }}</td>
  </tr>
</table>

In your console type this command line:

npx mikado-compile ./tpl/

<script type="module">
    import Mikado from "mikado.bundle.module.min.js";
    import template from "tpl/partial/user.js";
    const view = new Mikado(template, {/* options */});
</script>

<script src="mikado.bundle.min.js"></script>
<script src="tpl/partial/user.es5.js"></script>
<script>
    var view = new Mikado("user/list", {/* options */});
</script>

The name of a template inherits from its corresponding filename starting by the folder you've passed through the --src flag when calling the compiler.

After creation, you need mount the Mikado view instance to an HTML element as a destination for your render tasks:

view.mount(HTMLelement);
view.render(data);

You can also chain methods:

Mikado(template).mount(HTMLelement).render(data);

There is just a single convention you always need to keep in mind:

Every template has to provide one single root element as the outer boundary.

Instead of doing this in a template:

<header>
  <nav></nav>
</header>
<section>
  <p></p>
</section>
<footer>
  <nav></nav>
</footer>

Wrapping everything into a single outer root element by doing this:

<main>
  <header>
    <nav></nav>
  </header>
  <section>
    <p></p>
  </section>
  <footer>
    <nav></nav>
  </footer>
</main>

You can also use a <div> or any other element as a template root (also custom elements). The root element can also hold two special attributes key and cache. We will come later to it.

A bit more complex template:

<section id="{{ data.id }}" class="{{ this.state.theme }}" data-index="{{ index }}">
  {{@ var is_today = data.date === state.today }}
  <div class="{{ data.class }} {{ is_today ? 'on' : 'off' }}">
    <div class="title" style="font-size: 2em">{{ data.title.toUpperCase() }}</div>
    <div class="content {{ index % 2 ? 'odd' : 'even' }}">{{# data.content }}</div>
    <div class="footer">{{ state.parseFooter(data) }}</div>
  </div>
</section>

You can use any Javascript within the {{ ... }} curly bracket notation. The scope is limited by the template, so variables from one template can't be accessed within another template (use state for this purpose).

To pass HTML markup as a string, the curly brackets needs to be followed by # e.g. {{# ... }}. For better performance, relevant tasks avoid passing HTML contents as a string.

To use Javascript outside an element's context you need to prevent concatenation of the returned value. For this purpose, the curly brackets need to be followed by @ e.g. {{@ ... }}.

Within a template there are several reserved keywords you can use as an identifier:

You cannot change the names of those preserved keywords, also make sure you didn't override them.

It is recommended to pass custom functions via the state object (see example above state.parseFooter = function(str){ return str; }). Alternatively you can also nest more complex computations inline as an IIFE and return the result.

<div class="date">{{ 
    (function(){ 
        var date = new Date();
        // perform some code ...
        return date.toLocaleString();
    }())
}}</div>

To finish the example from above you need one single data object or an array of data items:

var data = [{
    "id": "230BA161-675A-2288-3B15-C343DB3A1DFC",
    "date": "2019-01-11",
    "class": "yellow, green",
    "title": "Sed congue, egestas lacinia.",
    "content": "<p>Vivamus non lorem <b>vitae</b> odio sagittis amet ante.</p>",
    "footer": "Pellentesque tincidunt tempus vehicula."
}];

Provide the optional state payload which includes specific values and helper methods used within template expressions:

const state = {
  today: "2019-01-11",
  theme: "custom",
  parseFooter: function(data) {
    return data.footer;
  }
};

Mount the view to a target element as a destination for all the render tasks:

view.mount(HTMLelement);

Render a mounted template:

view.render(data, state);

Render asynchronously automatically by just providing a callback function:

view.render(data, state, function() {
  console.log("finished.");
});

To render asynchronously by using promises you need to set the callback value to true:

// callback "true" will use Promises
view.render(data, state, true).then(function() {
    console.log("finished.");
});

// same, but uses async/await:
await view.render(data, state, true);
console.log("finished.");

When async should be the default strategy for all render tasks then you can also set the async option flag:

const view = new Mikado(template, { async: true });
await view.render(data, state);
console.log("finished.");

Define an HTML-like template and use double curly brackets to markup dynamic expressions which should be calculated and replaced during runtime:

<table>
  <tr>
    <td>User:</td>
    <td>{{ data.username }}</td>
  </tr>
  <tr>
    <td>Tweets:</td>
    <td>{{ data.tweets.length }}</td>
  </tr>
</table>

Save this template e.g. to tpl/partial/user.html

The preserved keyword data is a reference to the passed data item. You can access the whole nested object.

Mikado comes with a builtin template compiler you can simply access by typing npx mikado-compile into your console. The compiler uses a very simple command-line interface (CLI) running on Node.js to perform compilation tasks. The template compiles into a native javascript file which needs to be passed during creation of a Mikado instance. The same markup is also used for the server-side rendering part, so you can share the same template sources for client and server rendering.

Show help to list all available commands:

npx mikado-compile --help

Compile the template through the command line by:

npx mikado-compile tpl/partial/user.html

Basic Notation:

npx mikado-compile source <destination>

When no destination folder was set, the compiled files will be saved to the source folder. After compilation, you will have 3 different files:

1. list.js the template compiled as a ES6 module (which needs to be imported)
2. list.es5.js the template compiled as ES5 compatible Javascript (which automatically register when loaded by script tag)
3. list.html the source template you have implemented (do not delete it)

Extended Notation:

npx mikado-compile --src { source } --dest { destination } --extension html --type module --compact

Compiler Flags:

• --type module, -t module export as javascript modules (recommended)
• --type es5, -t es5 export as ES5-compatible package
• --extension html, --ext html, -e html the file extension which should be compiled
• --inline, -i or --compact, -c switch the build strategy to optimize either the performance (inline) or size (compact)
• --force, -f force overwriting existing files
• --pretty, -p do not minify the compiled result
• --watch, -w start the watcher for automatically compile when files has changed (just for development purposes)

Supported flags as attributes on the template root:

<!-- switch the build strategy to prebuilt enabled cache -->
<table cache="true"></table>

<!-- switch the build strategy to prebuilt disabled cache -->
<table cache="false"></table>

Using the flag attributes are the most performant variants but also cost you some flexibility, because the cache strategy couldn't be changed in runtime, it needs to change in markup before compilation.

There is a new naming system which will apply by default. The name of your html files will be used as unique identifiers of your templates. Because several folders can include same filenames, the template name inherits from the full path you pass in as --src.

Assuming the following file structure:

tpl/view/start.html
tpl/view/user.html
tpl/view/cart.html
tpl/partial/start.html
tpl/partial/user.html
tpl/partial/cart.html

The command should define the path /tpl/ as the source root because it is the most inner folder which covers all files:

npx mikado-compile ./tpl/

The template names then becomes view/start, view/user, view/cart and partial/start, partial/user, partial/cart for the partials. So when including just use this name in your expression <table include="partial/user">

The wrong way is to compile the folder /view/ and /partial/ separately, because their template names will be same.

npx mikado-compile ./tpl/view/
npx mikado-compile ./tpl/partial/

This might also work, but it is better not to do.

The option { cache: true/false } when creating a Mikado instance could be better declared withing templates on their root element, let the compiler produce more optimized code for this strategy.

<table cache="true">
    <!-- ... -->
</table>

Also use this approach when set cache="false":

<table cache="false">
    <!-- ... -->
</table>

A perfect fit for your local development environment is spawning a watcher to automatically compile files when they get changed. Just use the same command line you would also use for a full compilation and append the flag --watch or -w to it:

npx mikado-compile ./tpl/ --watch

Don't close the console, otherwise the watcher will stop. You can stop the watcher explicitly by pressing CTRL + C.

The template notation expects double curly brackets {{ ... }} for any kind of dynamic expressions.

Except when using {{@ ... }} for inline code notation, the returned value of every dynamic expression will be replaced to its position.

<div>{{ data.value }}</div>

view.render({ value: "test" });

You can also combine multiple expressions with non-expression contents:

<div>The title "{{ data.title }}" has the value: {{ data.value }}</div>

view.render({ title: "title", value: "test" });

You can also mix text nodes with elements on the same root element:

<div>Title: <b>{{ data.title }}</b><br>Value: {{ data.value }}</div>

view.render({ title: "title", value: "test" });

Also, you can use expressions within every attribute:

<div data-id="{{ data.title }}" class="{{ data.class }}">{{ data.value }}</div>

view.render({ id: 1, value: "test", class: "test" });

Every Javascript syntax is allowed withing expression:

<div style="color: {{ data.active ? 'green' : 'black' }}; {{ data.value ? '' : 'display: none;' }}"></div>

view.render({ active: true, value: "not empty" });

Since expressions just need to return a value you can also use IIFE:

<div>{{ 
    (function(){ 
        var date = new Date();
        // perform some code ...
        return date.toLocaleString();
    }())
}}</div>

view.render();

The inline code expression is the only one which doesn't return a value to be rendered in place, it just executes.

<div>
    {{@ const value = data.title.toUpperCase(); }}
    <h1>{{ value }}</h1>
</div>

view.render({ title: "title" });

The scope is limited to the template scope, but you can assign to state alternatively to share values across nested instances:

<div>
    {{@ state.value = data.title.toUpperCase(); }}
    <div include="header">
        <!-- contents of header.html:
        <h1>{{ state.value }}</h1>
        -->
    </div>
</div>

view.render({ title: "title" });

This will just output the result when it is not null, undefined, NaN or false.

<div>{{? data.value }}</div>

view.render([{
    value: null
},{
    value: NaN
},{
    value: undefined
},{
    value: false
}]);

This will escape the value before return. This is just important for the server-side-rendering part, the client automatically escape contents by default (except when using the HTML-expression).

<div>{{! data.value }}</div>

view.render({ value: "<b>html is not allowed</b>" });

This will allow for inserting HTML returned string.

Be aware of this can potentially lead into security issues like XSS. Use carefully!

<div>{{# data.value }}</div>

view.render({ value: "<b>html is allowed</b>" });

Mikado provides you high performant helper function you can use in this context to escape contents or to sanitize.

view.render({ 
    value: "<b>html allowed</b><br>" + Mikado.escape("<b>not allowed</b>")
});

view.render({ 
    value: "<b>html allowed</b><br>" + Mikado.sanitize("<b>not allowed</b>")
});

Using the sanitizer will remove the tags completely, whereas when escaping the content aren't removed but just escaped.

Define properties by using pure data object notation without any javascript inside:

<div class="{{= data.class }}">{{= data.value }}</div>

// store must be an array of elements:
const store = [{ class: "active", value: "foo" }];
// it needs a initial render if store isn't empty:
view.render(store);
// the store array now was proxified!

Now you can change the properties of store and the corresponding DOM elements will change automatically:

store[0].class = "inactive";
store[0].value = "bar";

Alternatively of using the npx mikado-compile you can also compile templates during runtime.

If a page has set a Content-Security-Policy (CSP) header field, using the runtime compiler has disadvantage when not configure script-src 'unsafe-eval'. It is recommended to use the Mikado native compiler, which is CSP-friendly and also can optimize your templates more powerful.

The runtime compiler uses the performance optimized inline strategy for every task, you can't switch it. The compiler property flag cache="true" or cache="false" on a template root is not supported, therefore you can't use 2 of the most performant strategies. But they are just slightly faster, so this shouldn't be an issue.

Those features aren't supported by the runtime compiler:

• cache="true" or cache="false" on a template root
• using any other compiler strategy than inline
• detect and replace repeating inline includes
• detect and solve/unroll non-dynamic expressions, e.g. <h1>{{ "foor" + "bar " }}</h1> will transform to a static content <h1>foobar</h1> and removes the expression completely
• runtime-ready templates aren't available on page load (they need to compile)

Define some HTML template structure:

<template id="user-list">
  <!-- just a single outer root element allowed: --> 
  <table>
    <tr>
      <td>User:</td>
      <td>{{ data.user }}</td>
    </tr>
    <tr>
      <td>Tweets:</td>
      <td>{{ data.tweets.length }}</td>
    </tr>
  </table>
</template>

Template definitions used by the runtime compiler needs manual naming when used as named includes.

The template name will derive from <template id="user-list"> or <template name="user-list"> and becomes user-list. When using named includes you will need to use this name for referencing, e.g. <div include="user-list">".

Compile the template and use it for creating a Mikado view instance:

const template = document.getElementById("user-list");
const tpl = Mikado.compile(template);
const view = new Mikado(tpl, { /* options */ });

view.render(data);

When the template was get through element ID you can use a shortcut:

const tpl = Mikado.compile("user-list");

Also, you can compile the template and use it for registration as a named include referenced by another template e.g. <div include="user-list">":

Mikado.register(Mikado.compile("user-list"));

You can use non-template elements for defining templates also:

#user-list{ display: none }

<!-- just a single outer root element allowed: --> 
<table id="user-list">
  <tr>
    <td>User:</td>
    <td>{{ data.user }}</td>
  </tr>
  <tr>
    <td>Tweets:</td>
    <td>{{ data.tweets.length }}</td>
  </tr>
</table>

Last but not least you can pass the template markup as a string:

const tpl_str = `
<table name="user-list">
  <tr>
    <td>User:</td>
    <td>{{ data.user }}</td>
  </tr>
  <tr>
    <td>Tweets:</td>
    <td>{{ data.tweets.length }}</td>
  </tr>
</table>`;

const tpl = Mikado.compile(tpl_str);
const view = new Mikado(tpl, { /* options */ });

view.render(data);

All the special attributes used to assign event routing within templates are inherited from the native inline listener name but without the prefix on, e.g. to bind routing for an "onclick" just use click.

Let's take this example:

<table data-id="{{ data.id }}" root>
  <tr>
    <td>User:</td>
    <td click="show-user">{{ data.user }}</td>
    <td><a click="delete-user:root">Delete</a></td>
  </tr>
</table>

There are 2 click listeners. The attribute value represents the name of the route. The second listener has a route separated by ":", this will delegate the event from the route "delete-user" to the closest element which contains the attribute "root".

Define routes:

view.route("show-user", function(target, event) {
    alert(target.textContent);
});

view.route("delete-user", function(target, event) {
    // target was delegated to "root" by using the colon expression
    alert(target.dataset.id); 
    // when target is delegated you can still get the
    // original element where the event was fired:
    const anchor = event.target;
});

Routes are stored globally, so they share through all Mikado instances.

List of all supported events:

• tap (synthetic touch-enabled "click" listener, see below)
• change, input, select, toggle
• click, dblclick
• keydown, keyup, keypress
• mousedown, mouseenter, mouseleave, mousemove, mouseout, mouseover, mouseup, mousewheel
• touchstart, touchmove, touchend
• submit, reset
• focus, blur
• load, error
• resize
• scroll

Synthetic events:

When multiple listeners of the same type are nested, the event will bubble up to the HTML root element when enabling the global flag Mikado.eventBubble = true, otherwise bubbling will stop on the most inner definition which gets matched.

<table>
    <tr click="route-tr">
        <td click="route-td"></td>
        <td></td>
        <td></td>
    </tr>
</table>

Mikado.route("route-td", function(target, event){
    console.log("clicked td");
});

Mikado.route("route-tr", function(target, event){
    console.log("clicked tr");
});

By default, the above example will just execute the route named "route-td" when clicked on the TD element. When Mikado.eventBubble = true was enabled the bubble continues after calling the most inner matched handler and both routes will be executed when clicking on TD element.

To control Mikados internal event bubbling mechanism you can pass in options as the 3rd parameter when defining routes:

Mikado.route("route-td", function(){ /*...*/ }, { stop: true });

Supported Options (mixable):

• stop: boolean stop capturing/bubbling the event up to the root element (stops Mikado event + native event)
• prevent: boolean prevents the default behavior for this native event
• cancel: boolean just stop bubbling the Mikado event, but the native event bubbling will still continue
• once: boolean just catch the event once and remove the route then

You can cache more complex event delegations by setting the global flag Mikado.eventCache = true. A candidate for a complex delegation is forwarding a different target to the handler by using the ":" colon notation or when using Mikado.eventBubble = true.

When using Event Cache the scope of forwarding custom target elements to the handler and also nested routes of the same event type should be defined in the same template scope. Thinks may break when components are shared through multiple instances.

This is okay, because all partials are inline:

<table foreach="data.result" root>
    <!-- a new template scope -->
    <tr foreach="data.user" click="route-tr:root">
        <!-- a new template scope -->
        <td click="route-td:root">{{ data.username }}</td>
    </tr>
</table>

When using extern includes it might produce unexpected behavior:

tpl.html:

<table foreach="data.result" root>
    <!-- a new template scope -->
    <tr foreach="data.user" include="tpl-td">
        <!-- a new template scope -->
    </tr>
</table>

tpl-td.html:

<td click="route-td:root">{{ data.username }}</td>

This will have no side effects when the partial "tpl-td.html" is just use for the template "tpl.html". But imagine you have another template which includes "tpl-td.html" and also one of the recycle strategies (keyed, non-keyed) was enabled on both. In this specific situation the cache might point to a false element <table root> used to forward to the handler. Then you need to choose between: 1. limiting the scope of used event notation to the template scope, 2. do not enable Mikado.eventCache = true.

You can use Mikado routing and event delegation feature everywhere, also outside a template. Just apply the event attribute as you would do in a template.

<body>
  <div click="handler">Click Me</div>
</body>

Mikado.route("handler", function(target, event) {
  console.log("Clicked");
});

Then you have to explicit register the global "click" listener once:

Mikado.listen("click");

Because events automatically register when creating the template factory under the hood. When no template was created which includes the same type of event, a global listener does not exist. For that reason, you have to explicitly register the listener once.

The default "EventListenerOptions" are set to true by default and is using the capturing phase, this is preferred since the event is required on a global listener.

When you need to configure event capturing and passive listener globally just register the specific listener manually before creating any Mikado instance which is including references to this specific event type:

Mikado.listen("touchmove", {
    passive: true,
    capture: true 
});

Unregister listener:

Mikado.unlisten("click");

Mikado will store the original EventListenerOptions when calling .listen(event) under the hood, to make sure the listener will be removed properly.

Manually dispatch a route:

view.dispatch("route-name");

Manually dispatch a route and pass parameters for the assigned handler:

view.dispatch("handler", target, event);

Each template instance can run in its own mode independently.

A non-keyed recycle strategy will re-use all existing components without any limitations and is faster than keyed but also has some side effects when not used properly. That's why limitation by keyed data is a more common strategy for recycling. But when an unlimited recycle strategy was used carefully you won't get any disadvantages.

Just provide a template as usual:

<div>
  <div>User:</div>
  <div>{{data.name}}</div>
</div>

along with these options:

var view = new Mikado(template, { recycle: true });

This will switch Mikado into a recycle strategy to enable re-use of already rendered components.

A keyed strategy limits the recycle strategy on components matching the given data key. It just requires a unique identifier on each rendered item (e.g. the ID).

Just add the attribute key to the root element of a template (or the root of an inline partial) and assign the scope to the unique identifier will automatically switch Mikado into keyed-recycle mode:

<div key="data.id">
  <div>User:</div>
  <div>{{ data.name }}</div>
</div>

A given key in template does not need the recycle: true option to be passed.

var view = Mikado(template);

This will switch Mikado into a recycle strategy which is limited by its corresponding data keys.

Create a view by passing a template and customized options:

var view = Mikado(template, options);

Create a view and also mount it to a target element right away (you can also do this before render):

var view = Mikado(template, { 
    mount: HTMLElement
});

Whenever .mount() is called for the first time, the template factory will be created once. Also, within this routine the hydration will apply when enabled. You can "prebuild" views by mounting early. Bigger sized applications does not hold all views in memory, so here it is recommended to mount the view right before render view.mount(node).render(data).

Mount or re-mount a view to an HTML element:

view.mount(element);

Destroy a view:

view.destroy();

Render just a single data object:

view.render({/* object */});

Render a template repeated incrementally through a set of data items:

view.render([/* array of objects */]);

Render a template and also pass a custom state:

view.render(data, state);

When passing a custom state you can still access the original view state by using this.state within template expressions.

Schedule an asynchronous render task without any callback:

view.render(data, state, true);

All asynchronous render tasks will be scheduled to the next animation frame.

Schedule an asynchronous render task by using a callback:

view.render(data, state, function() {
  // finished
});

Schedule a render task by using promises (requires the option async to be enabled during initialization):

view.render(data, state).then(function() {
  // finished
});

Or as async/await (requires the option async to be enabled during initialization):

await view.render(data, payload);
// finished

Render a static template (didn't include any dynamic contents):

view.render();

Just create a component from a template without adding/assigning/rendering them to the root ("orphan"):

var partial = view.create(data);

Orphans are not a part of the internal render tree of a view. The construction of orphan components is also really fast.

Add one data item to the end:

view.add(data);

Add one data item to a specific index position (did not replace):

// add to beginning:
view.add(data, 0);

Add one data item to a reversed index position (did not replace):

// add before the last element:
view.add(data, -1);

Append multiple data items to the end:

view.append(data);

Append multiple data before an index:

// append to beginning
view.append(data, 0);

Append multiple data before a reversed index position:

// append before the last element:
view.append(data, -1);

Remove a specific template node:

Parameter: remove(position, <count>)

view.remove(node);

Remove a specific template node by its index:

view.remove(20);

Remove a specific template node by its reversed index:

// remove the last:
view.remove(-1);

Remove a range of nodes starting from a specific node or index (included in removal):

view.remove(20, 10);

view.remove(node, 20);

Remove last 20 node items by using reversed index:

view.remove(-20, 20);

Remove previous 20 node items starting of a given node/index (included in removal):

view.remove(node, -20);

Remove all:

view.clear();

Replace a data item/node:

view.replace(node, data);

view.replace(index, data);

Update a single data item/node:

view.update(node, data);

view.update(index, data);

Get a components root element by a specific index:

var node = view.node(index);

Get the index from a specific components root element:

var index = view.index(node);

Get the length of all components currently rendered:

var length = view.length;

Get the current template name which is assigned to a Mikado instance:

var name = view.name;

Get the mounted root element on which the template is assigned to:

var element = view.root;

Mikado provides you several optional helper functions to manipulate the DOM and also keep them in sync with the internal view state. Using the helper functions also will gain performance.

All helpers support passed parameter by index or by node.

Helpers let you apply simple transformations without running through the whole render loop of the template. Reconciliation isn't the holy grail, it is just for your laziness. In certain situations it is just more efficient to apply a known transformation directly instead of altering the data and request a whole render task.

Move a data item/node to a specific index position:

view.move(node, 15); // 15 from start
view.move(node, -15); // 15 from end

Move a data item/node to the top or bottom:

view.first(node);
view.last(node);

Move a data item/node by 1 index up or down:

view.up(node);
view.down(node);

Move a data item/node by a specific offset (pretty much the same as shift):

view.up(node, 3);
view.down(node, 3);

Shift a data item/node relatively by a specific offset (both directions):

view.shift(node, 3);
view.shift(node, -3);

Move a data item/node before or after another data item/node:

view.before(node_a, node_b);
view.after(node_a, node_b);

Swap two data items/nodes:

view.swap(node_a, node_b);

Caching of DOM properties can greatly increase performance (up to 20x). There are just a few situations where caching will not improve performance, it fully depends on your application.

Recommendation: enable caching when some of your data will stay unchanged from one to another render task. Disable caching when changes on data almost requires a fully re-render.

The state cache will just apply when recycle was enabled or the keyed strategy was used. Otherwise, the cache is never used.

Caching is disabled by default, you will need to explicitly set this flag when initializing:

const view = new Mikado(template, { 
    recycle:true,
    cache: true 
});

It is very recommended reading the next section to understand how caching is working.

Let's take a simple template as an example:

<root>
  <div class="active">{{ data.title }}</div>
</root>

The template above has just one dynamic expression. It could be rendered as follows:

view.render({ title: "foobar" });

Assume you get new data and wants to update the view, but the new data has still the same value for the title:

view.render({ title: "foobar" });

This time, when cache was enabled no changes are applied to the text node, since the new value matches the previous cached value. That specific part now executes more than 10,000 times faster. Make a maximum use of this strategy will speed up things amazingly.

Now let's come to the most important part when using caching properly. Assume you have rendered the template above with caching enabled. Now you manually change parts of the DOM which is covered by a dynamic template expression:

var node = document.querySelector(".active");
node.textContent = "manual change";

The changes will apply to the DOM as expected. Now you re-render the template with the "old" state from the previous render:

view.render({ title: "foobar" });

This time the change will not apply! Because the internal cache assumes that the current value is still "foobar" and skips the change.

You have 2 options in this situation:

1. Do not manually change dom entries which are part of a dynamic template expression and update specific parts through rendering templates only.
2. Using the DOM Cache Helpers Mikado provides you exactly for this situation.

Caching helpers let you apply manual changes to the DOM easily without going out of sync with the corresponding view instance.

It is recommended also using these helpers to any DOM changes regardless if it is part of the template or not. Generally, these helpers will greatly improve your application performance.

A well implemented application can still save between 20 and 40% of unnecessary DOM access just by using those helpers everywhere. On regular implementations it is almost between 50% and 70%.

Set an attribute of a node (will not replace old attributes):

Mikado.setAttribute(node, "href", "/foo");

Set multiple attributes of a node (will not replace old attributes):

Mikado.setAttribute(node, {
  id: "foo",
  href: "/foo"
});

Get an attribute value of a node:

var attr = Mikado.getAttribute(node, "href");

Remove an attribute of a node:

var attr = Mikado.removeAttribute(node, "href");

Remove multiple attributes of a node:

var attr = Mikado.removeAttribute(node, ["href", "target"]);

Check existence of a nodes attribute:

var href = Mikado.hasAttribute(node, "href");

Set class name of a node (fully replaces old classes):

Mikado.setClass(node, "class_a class_b");
```~~
~~
```js
Mikado.setClass(node, ["class_a", "class_b"]);

Add a classname to a node:

Mikado.addClass(node, "class_a");

Add multiple classnames to a node:

Mikado.addClass(node, ["class_a", "class_b"]);

Get all classnames of a node (returns an array):

var classList = Mikado.getClass(node);

Toggle classnames of a node:

var classList = Mikado.toggleClass(node, "class_a");

Toggle classnames of a node to a specific state (a short variant of conditional "add" and "remove"):

var classList = Mikado.toggleClass(node, "class_a", true);

Toggle multiple classnames of a node:

var classList = Mikado.toggleClass(node, ["class_a", "class_b"]);

Toggle multiple classnames of a node each of them to a specific state:

var classList = Mikado.toggleClass(node, {
    "class_a": true,
    "class_b": false
});

Check existence of a nodes classnames:

var class_a = Mikado.hasClass(node, "class_a");

Removes a classnames of a node:

Mikado.removeClass(node, "class_a");

Removes multiple classnames of a node:

Mikado.removeClass(node, ["class_a", "class_b"]);

Set the whole elements inline style tag style="..." (fully replaces old styles):

Mikado.setCss(node, "top: 0; padding-right: 10px");

Mikado.setCss(node, ["top: 0", "padding-right: 10px"]);

Get all inline styles of a nodes style tag:

var css = Mikado.getCss(node);

Set a specific inline style of a node (will not replace old styles):

Mikado.setStyle(node, "padding-right", "10px");

Set multiple specific inline styles of a node (will not replace old styles):

Mikado.setStyle(node, { "top": 0, "padding-right": "10px" });

Get a specific inline style value of a node:

var padding = Mikado.getStyle(node, "padding-right");

Set text of an element or text node:

Mikado.setText(node, "This is a title.");

Get text of an element or text node:

var text = Mikado.getText(node);

Set inner HTML of an element:

Mikado.setHtml(node, "<b>This is a title.</b>");

Get inner HTML of an element:

var html = Mikado.getHtml(node);

Every Mikado instance has by default a state object you can access by view.state.

State is a payload keeping values and functions during runtime you can use within template expressions additionally to the data. The state also will be delegated through the whole render loop (including partials). You can bind one global state to every Mikado instances, you can also assign a dedicated state for each view. Additionally, a custom state could be passed on all render tasks.

const view = Mikado(template, options);
console.log(view.state); // {}

When creating an instance you can optionally pass an extern state via options to share the same state object through multiple views:

const state = { foo: 1 };
const view_a = Mikado(template_a, { state });
const view_b = Mikado(template_b, { state });
console.log(view_a.state); // { foo: 1 }
console.log(view_b.state); // { foo: 1 }

You can access the state within templates by the builtin keyword "state" or also by using "this" which points to the current Mikado instance.

<div>
    <p>{{ state.foo }}</p>      <!-- output: 1 -->
    <p>{{ this.state.foo }}</p> <!-- output: 1 -->
</div>

When using .render() you can optionally pass a state as 2nd parameter which will temporarily override the views default keyword "state" for this specific render task:

const state = { foo: 1 };
const view = Mikado(template, { state });
view.render(data, { foo: 2 });

<div>
    <p>{{ state.foo }}</p>      <!-- output: 2 -->
    <p>{{ this.state.foo }}</p> <!-- output: 1 -->
</div>

As you can see you can still access the original state by using this.state.

When using foreach the keyword data within nested template expressions refers to the most inner element.

<!-- data points to root -->
<table foreach="data.rows">
    <!-- data points to root.rows[] -->
    <tr foreach="data.columns">
        <!-- data points to root.rows[].columns[] -->
        <td>{{ data.value }}</td>
    </tr>
</table>

If you need the root data element within nested templates then just assign the data to the state or pass a temporary state object as 2nd parameter by simply using .render(data, data). Now you can access the root data element via state through all the template scopes.

The 2nd parameter view of custom callbacks points to the Mikado view instance.

Define custom callbacks during initialization:

var view = new Mikado(template, {
  on: {
    create: function(node, view) {
      console.log("created:", node);
    },
    recycle: function(node, view) {
      console.log("recycled:", node);
    },
    insert: function(node, view) {
      console.log("inserted:", node);
    },
    update: function(node, view) {
      console.log("updated:", node);
    },
    replace: function(node, view) {
      console.log("replaced:", node);
    },
    remove: function(node, view) {
      console.log("removed:", node);
    },
    mount: function(root, view) {
      console.log("mounted:", root);
    },
    unmount: function(root, view) {
      console.log("unmounted:", root);
    }
  }
});

When a template has no dynamic expressions (within curly brackets) which needs to be evaluated during runtime Mikado will handle those templates as static and skips the dynamic render part. You can render static views without passing data.

When a template just needs to be rendered once you can theoretically create, mount, render and destroy as follows:

Mikado(template)
  .mount(root)
  .render()
  .destroy();

You can also simply use a shorthand function:

// static views doesn't require data
Mikado.once(root, template);

// if the view has dynamic contents just pass data
Mikado.once(root, template, data);
// full example by also using async callback
Mikado.once(root, template, data, state, callback);

There is one important advantage when using once over render. It will always append to the root without mounting:

Mikado.once(document.body, template);

When using render instead you probably can't do that, because it needs mounting and document.body isn't a root which just includes elements from the same template. So using Mikado.once is great when initializing your app and building the shape of the DOM layout.

If a view was destroyed you will need to create the Mikado instance again when re-using.

Just use the same template syntax (or same source files also served for the client).

const mikado = require("mikado/ssr");
const view = await mikado.compile("view/start.html", {
    compression: true,
    debug: false,
    cache: 200
});

// render the html markup
const html = view.render([{ /* data */ }]);

// send the html to the client, e.g.:
res.send(html);

Supported Options (mixable):

• compression minify the html markup (true/false)
• debug when enabled it compiles the template on every render, good for development environments (true/false)
• cache sets the size of the encoder-cache (true/false/number)
• csr when set to "false" it fully unlocks template restrictions applied by the support of client-side-rendering

By explicitly setting the option csr to "false" you can switch into SSR-exclusive mode where the limitation of having one outer element as the template root is unlocked, also there is an extract directive to place logical placeholder elements, which will be self-extracted when rendered.

const mikado = require("mikado/ssr");
const view = await mikado.compile("view/start.html", {
    csr: false
});

<div if="data.length" extract>
    <table foreach="data">
        <tr>
            <td>1</td>
        </tr>
        <tr>
            <td>2</td>
        </tr>
        <tr>
            <td>3</td>
        </tr>
    </table>
</div>

Those templates aren't supported by the client render engine, also you can't hydrate them.

const mikado = require("mikado/express");
const express = require("express");
const app = express();

// set path to your static views
app.set("views", [
    __dirname + "/view"
    // ...
]);

// set path to your partial views (optional)
app.set("partials", [
    __dirname + "/partial"
    // ...
]);

// register engine to filetype .html
app.engine("html", mikado);
// enable engine for filetype .html
app.set("view engine", "html");

You can set options by Express app.set:

// enable compression (optional)
app.set("view compression", true);
// enable cache and set pool size (optional)
app.set("view cache", 200);
// set debug to false to enable compiler cache
app.set("view debug", false);

Or you can specify options by mikado.options alternatively:

mikado.options = {
    compression: true,
    cache: 200,
    debug: false
};

Register a route and render the file ./view/start.html:

app.get("/", function(req, res){

    res.render("view/start", [{ /* data */ }]);
});

Partials gets its own instance under the hood. This performance gain also makes a template factory re-usable when the same partials are shared across different views.

Be aware of circular includes. A partial cannot include itself or somewhere later in its own chain.

Assume you've created one or more partial templates. Make sure each of the partial templates is providing one single root as the outer bound.

The file structure might look like:

• tpl/header.html
• tpl/article.html
• tpl/footer.html

You will need to compile the templates:

npx mikado-compile ./tpl/

You have to register all partial templates once before you initialize the templates which will including them:

import tpl_header from "./tpl/header.es6.js";
import tpl_article from "./tpl/article.es6.js";
import tpl_footer from "./tpl/footer.es6.js";

Mikado.register(tpl_header);
Mikado.register(tpl_article);
Mikado.register(tpl_footer);

When using templates in ES5 compatible format, they are automatically registered by default when loaded.

Include partial templates in another template tpl/section.html:

<section>
  <header include="header"></header>
  <article include="article"></article>
  <footer include="footer"></footer>
</section>

The "section" from above could be also included by another one (and so on):

<html>
<body>
    <main foreach="data.sections" include="section"></main>
</body>
</html>

Assume the template example from above is a tweet (title, article, footer).

<section>
  <title>{{ data.title }}</title>
  <tweets foreach="data.tweets" include="tweet">
    <!-- tweet -->
    <!-- tweet -->
    <!-- tweet -->
  </tweets>
</section>

This expression will render the template "tweet" through an array of data items/tweets. The template "tweet" is getting the array value data.tweets as data.

The limit and offset attributes could be used optionally to specify a custom portion of the partial loop:

<tweets foreach="data.tweets" include="tweet" limit="5" offset="5"></tweets>

The offset attribute could also be negative to reverse the boundary direction, e.g. loop through the last 5 items:

<tweets foreach="data.tweets" include<
B301
/span>="tweet" limit="5" offset="-5"></tweets>

You can also loop through an inline partial. Mikado will extract and referencing this partial to its own instance under the hood.

<main>
  <title>{{ data.title }}</title>
  <tweets foreach="data.tweets">
    <section>
      <header include="header"></header>
      <article include="article"></article>
      <footer include="footer"></footer>
    </section>
  </tweets>
</main>

You can also nest loops:

<!-- root view -->
<tweets foreach="data.tweets">
  <!-- new partial template -->
  <tweet>
    <h1>{{ data.title }}</h1>
    <title>Comments:</title>
    <div foreach="data.comments">
      <!-- new partial template -->
      <comment>
        <p>{{ data.content }}</p>
        <title>Replies:</title>
        <div foreach="data.replies">
          <!-- new partial template -->
          <p>{{ data.content }}</p>
        </div>
      </comment>
    </div>
  </tweet>
</tweets>

Every looped partial has to provide one single element root as the outer bound.

In this example every foreach-expression is wrong (you will find the right example above):

<tweets foreach="data.tweets">
  <!-- no outer bound! -->
  <h1>{{ data.title }}</h1>
  <title>Comments:</title>
  <div foreach="data.comments">
    <!-- no outer bound! -->
    <p>{{ data.content }}</p>
    <title>Replies:</title>
    <div foreach="data.replies">
      <!-- no outer bound! -->
      {{ data.content }}
    </div>
  </div>
</tweets>

<main>
  <title if="data.tweet.length">Tweets: {{ data.tweet.length }}</title>
  <title if="!data.tweet.length">No tweets found.</title>
</main>

<main>
  <title>{{ data.title }}</title>
  <tweets if="data.tweets.length" foreach="data.tweets">
    <section>{{ data.content }}</section>
  </tweets>
</main>

<main>
  <title>{{ data.title }}</title>
  <tweets foreach="data.tweets">
    <section if="data.content">{{ data.content }}</section>
  </tweets>
</main>

Think in real code branches, instead of doing this:

<main>
  {{@ var result = (function(){ return "some big computation"; }()) }}
  <section if="data.content">{{ result }}</section>
</main>

Doing this:

<main>
  <section if="data.content">
    {{ (function(){ return "some big computation"; }()) }}
  </section>
</main>

Conditional branches will skip their expressions inside when not taken.

Also, try to assign computations outside a loop by using the state to delegate values to the scope of the partial loop:

<main>
  {{@ state.result = (function(){ return "some big computation"; }()) }}
  <tweets foreach="data.tweets">
    <section>{{ state.result }}</section>
  </tweets>
</main>

Mikado provides you a reactive approach to listen for changes to the data and apply them accordingly to the DOM. It is based on native Proxy feature which has great performance, a small memory footprint and fully falls back to a legacy observer when Proxy is not available. Using a reactive strategy can additionally boost performance beyond a factor of 100 when updating specific data instead of leverage a full render task. It depends on your application or current view, this feature has an advantage when updating data partially has to process more often than full data updates.

Template markup:

<table>
  <tr>
    <td>Name:</td>
    <td>{{= data.name }}</td>
  </tr>
  <tr>
    <td>Email:</td>
    <td>{{= data.email }}</td>
  </tr>
</table>

The expression for an observable property uses this syntax: {{=. You can combine with other expressions, but should be defined at least, e.g. {{#= or {{!= or {{?=.

You can't use any Javascript code inside reactive expressions, just the full data scope of the value is allowed to specify within those expressions.

When using reactive properties you'll need to manage a store (could be a simple Array) which gets proxified under the hood.

// store must be an array of elements:
const store = [/* Array of objects */];

// create, mount and initial render the store by using
// a template which has reactive properties included
Mikado(template).mount(root).render(store);

// the store now has proxified item properties!
// do not throw it away, instead apply updates on it
store[0].name = "John Doe";
store[0].email = "john@doe.com";

// when data changes, the corresponding DOM elements
// will automatically change also

The data store must be an Array of elements, also when just having one item. Because the array index reference gets proxified, that's why you can't pass a single object.

If you just have a single data item, and you don't like the array index access you can also define a reference, but you need to do this after initially calling render:

const store = [{ class: "active", value: "foo" }];
// the store isn't proxified
const test = store[0];
// initial render
view.render(store);
// the store array now was proxified!
const item = store[0];

// these objects aren't the same anymore
console.log(test === item); // false

// nothing will change on screen:
test.value = "bar";
// this works properly
item.value = "bar";

On the upper example nothing on the DOM will change when you set the values test.value = "bar", because this reference holds the un-proxified original version. Set item.value = "bar" will work properly.

Actually there are some limitations on template expressions.

1. Fields from deeply nested data objects are not reactive:

var data = {
  id: "foobar", // <-- observable
  content: {    // <-- observable
    title: "title",  // <-- NOT
    body: "body",    // <-- NOT
    footer: "footer" // <-- NOT
  }
};

2. Template expressions including any kind of Javascript syntax are not supported:

<table>
  <tr>
    <td>Name:</td>
    <!-- Supported: -->
    <td>{{= data.name }}</td>
  </tr>
  <tr>
    <td>Tweets:</td>
    <!-- Not Supported: -->
    <td>{{= data.tweets ? data.tweets.length : 0 }}</td>
  </tr>
</table>

Just use plain property notation within the curly brackets.

Whenever all your template expressions are just using proxy notation it enables a special "strict-proxy" mode under the hood, which further boosts performance from every update to a maximum. This mode has no advantage when every render loop has to apply almost new items.

This enables "strict-proxy" mode:

<item>
  <caption>
    Name:
  </caption>
  <p>{{= data.name }}</p>
  <caption>
    Email:
  </caption>
  <p>{{= data.mail }}</p>
</item>

This won't enable it:

<item>
  <caption>
    Name:
  </caption>
  <p>{{= data.name }}</p>
  <caption>
    Email:
  </caption>
  <p>{{ data.mail }}</p>
</item>

Also using conditionals, includes, loops and inline Javascript will prevent switching to the "strict-proxy" mode. You can't switch this mode by yourself. It just activates when conditions are met.

In addition to react on changes of property values you can additionally also listen to changes made to the Array index of the store. Mikado provides you an observable Array that acts like a native Array and apply all changes to a synchronized NodeList under the hood. It also uses native Proxy which fully falls back to a legacy observer, when not available.

Semantically the observable array you will get from Mikado.Array() is equal to an array-like Javascript Array.

Create an observable array:

var store = new Mikado.Array();

Create an observable array with initial data:

var items = [ ... ];
var store = new Mikado.Array(items);

Every observable array needs to bind to a mounted Mikado instance, because it needs to apply render tasks somewhere:

var view = Mikado(template, { observe: store, mount: root });

Now the observable array is linked with your instance. Whenever you change the array all changes apply automatically to the corresponding template.

You can use all common array built-ins, e.g.:

store.push({ ... });

var last = store.pop();

store.unshift({ ... });

var first = store.shift();

store.slice(3, 1);

store.splice(0, 1, { ... });

You can get and set via array index access. This feature also has a non-proxy fallback included.

store[0] = { ... };

store[store.length] = { ... };

var first = store[0];

A list of all supported array prototypes:

• length
• push
• pop
• shift
• unshift
• slice
• splice
• concat
• indexOf
• lastIndexOf
• filter
• map
• reverse
• sort
• swap

These methods are implemented, without some extensions like parameter chaining, e.g. array.push(a, b, c) is not available, instead, you have to call push for each item one by one.

There are some methods which slightly differs from the original implementation of native Arrays. These methods will apply changes in place and returning the original reference instead of applying on a copy:

• concat
• filter
• map

58BF When you need the original native behavior you can simply do that by:

var new_array = [ ... ];
var copy = Array.prototype.concat.call(store, new_array);

var copy = Array.prototype.filter.call(store, function(){ ... });

In a situation when falling back to the non-proxy polyfill because of missing support for native Proxy, there is a limitation. You cannot fill sparse arrays or access indexes which are greater than the current array.length. There is just one undefined index that could always access (by read/write) that is the last "undefined" index on an array when you call array[array.length]. This index is a special marker that increases the "virtual" array size. Whenever you assign a value to this special index the size of the observable index growth automatically and the next "undefined" index in the queue becomes this marker. This limitation is not existing when the ES6 proxy is available.

Also, there are some divergent characteristics when using reflection:

var store = Mikado.Array();
console.log(store.constructor === Array); // -> false
console.log(store.prototype === Array.prototype); // -> false
console.log(store instanceof Array); // -> false
console.log(Array.isArray(store)); // -> false
console.log(store instanceof Mikado.Array); // -> true

The proxy feature theoretically allows all those checks but could not be used to keep the polyfill working in addition to sharing most of the same codebase. Alternatively you can use an instanceof check for identification.

Using pools greatly enhance the strategy of keyed and non-keyed recycling. Mikado detects automatically if it needs to use keyed or non-keyed pooling and will apply different strategies optimized for each of them.

Pools just enables (regardless of the passed options) when one of the recycle strategy was used: keyed or non-keyed.

Enable pool and limit pool size (keyed and non-keyed:

const view = new Mikado(tpl, { pool: 200, recycle: true });

A proper value of pool size should be set at least to the max amount of items which is rendered in one loop (e.g. a page of 30 items). Using twice of this length is recommended, when your components aren't oversized or when page has less than 100 items to render.

Enable pool with unbounded pool size (non-keyed only):

const view = new Mikado(tpl, { pool: true, recycle: true });

In keyed mode you should only use an unbounded pool size, when the total amount of data is very limited (e.g. less than 300 items). To be safe you should always limit the pool when using keyed recycling.

You can delete pool contents at any time:

view.flush();

Hydration is a concept where the server is sending some basic HTML structure (or the whole App/Page) and the client consumes those contents into its own rendering system. This will improve several performance aspects of page loading (e.g. the Lighthouse test) but also it enables you to have server-side-rendered content by also providing a full PWA (aka "Single-Page-Application") experience at the same time.

Mikado uses hydration strategy, where components are hydrated progressively right before a render task will be performed.

Assume the server was sending this HTML structure as initial:

<html>
<body>
  <main>
    <section>
      <title>Title</title>
      <tweets>
        <tweet><!-- ... --></tweet>
        <tweet><!-- ... --></tweet>
        <tweet><!-- ... --></tweet>
      </tweets>
    </section>
  </main>
</body>
</html>

Your template looks like:

<section>
  <title>{{ data.title }}</title>
  <tweets foreach="data.tweets">
    <tweet>
      <h1>{{ data.title }}</h1>
      <title>Comments:</title>
      <div foreach="data.comments">
        <comment><!-- ... --></comment>
      </div>
   </tweet>
  </tweets>
</section>

When a mounted template matches the same DOM structure like the component which should be hydrated, the initialization of the template will boot up faster because the factory is derived instead of created. You can use Mikados SSR feature to provide client-compatible structures on the server-side.

When DEBUG is enabled (or by using one of the debug builds) you'll get a message in the console when hydration falls back into factory construction because of an incompatible DOM structure.

You can hydrate the existing structure when creating instance (prefetch):

const root = document.querySelector("main");
const view = new Mikado(tpl, { mount: root, hydrate: true });

You can also do this just right before mounting by passing the 2nd parameter:

const view = new Mikado(tpl);
// ... somewhat later in the runtime
view.mount(document.querySelector("main"), /* hydrate? */ true);

When a hydration breaks because it isn't compatible for some reason, it fully skips this process silently (logs a message when DEBUG was enabled) and falls back to a construction of a factory instead.

When using shadow DOM to build web components the compiler needs to apply a different strategy. Therefore, you will need 2 additional template tags:

1. <component/> as the outer root will enable rendering on a shadow root
2. <template/> will identify your template from the rest of markup

<component>
  <!-- optional styles/scripts/etc. -->
  <link href="css/component.css" rel="stylesheet">
  <script src="js/component.js"></script>
  <style>#user-list{ width: 100%; }</style>
  <script>window.username = "John";</script>
  <!-- components requires the template tag -->
  <template>
    <!-- single outer root element: -->
    <table id="user-list">
      <tr>
        <td>User:</td>
        <td>{{ window.username }}</td>
      </tr>
      <tr>
        <td>Tweets:</td>
        <td>{{ data.tweets.length }}</td>
      </tr>
    </table>
  </template>
</component>

You can't use any template expressions outside <template/>.

You can also render any normal template (non-components) to a plain dedicated shadow root by using the shadow: true option (also supported by the light bundle):

const view = new Mikado(tpl, { shadow: true });

Theoretically you can put the <link/>, <style/> and <script/> inside a normal non-component template by also using the shadow: true option. But there is one important difference. Within a normal template those tags could be re-rendered and this might end in re-initializing of all those assets. Within a web component there is a top level scope, which is created once and will stay for all your further template tasks. The template will render on a new "hidden" element <root/> which is part of the top level scope. That is because the view needs to be mounted to an element, and the top level scope of shadow root couldn't be mounted because of mixed content. Don't rely on the existence of <root/>, when using static templates or view.once() it might not exist.

Assume when mounted a web component template to an element <main>, the DOM structure looks like: