hyperHTML styleguide

Abstraction is the price you pay for the magic.

hyperHTML is a DOM & ECMAScript standard compliant, zero-dependency, fully cross platform library suitable for declarative and reactive Web Applications.

This architecture and styleguide has been written for showing best practices about hyperHTML in my use cases and context, mainly in ES2015 without any transpiling step (and finally without any bundling one).

In the latest years I developed web applications with AngularJS. That framework served me very well and introduced me a lot of concepts used in MVC architectures.

When I chose hyperHTML in early 2017, at the beginning it was natural to reproduce that kind of context, even if the paradigm was different.

Be aware your mileage may vary.

This is an opinionated styleguide for syntax, conventions and structuring hyperHTML applications. Anyway the framework is very flexible, intending it is not too much opinionated. It adds enough abstraction to hide boring details and not too much bells and whistles to hide the platform.

Before thinking there is something wrong in the framework, check the docs (RTFM) and the issues - they are a very worthy reading - and try to discover (again) the original specs (DOM) behind the framework. I need to shift my mind to be used to hyperHTML.

Table of Contents

Modular architecture
Components
1. Theory
2. Controllers
3. Templates
4. Services
Utils
How To
1. A Modal Dialog
Made with hyperHTML
Resources
Documentation
Contributing
Credits

Modular architecture

A module component is the root definition for that module that encapsulates the component boostrap, the logic, controller, template, services and, finally, child components.

Back to top

Module theory

The design in the modules maps directly to our folder structure, which keeps things maintainable and predictable. We should ideally have three high-level modules: root, component and common. The root module defines the base module that bootstraps our app, and the corresponding template. We then import our component and common modules into the root module to include our dependencies. The component and common modules then require lower-level component modules, which contain our components, controllers, templates, services, utilities and tests for each reusable feature.

Back to top

Root module

The root module may be loaded via script tag with type module or it may be the entry point for your preferred bundler.

<script type="module" src="app/root.module.js"></script>

// root.module.js
import "./root.component.js";
import "./common/common.module.js";
import "./components/components.module.js";

The root component defines the base element for the entire application.

// root.component.js
import { Util } from "./util.js";
import { RootTemplate } from "./root.template.js";

export class RootComponent {
    static bootstrap() {
        const render = hyperHTML.bind(Util.query("root"));

        RootTemplate.update(render);
    }
}

RootComponent.bootstrap();

Back to top

Component module

A Component module is the container reference for all reusable components. See above how we import components.module.js and inject them into the Root module, this gives us a single place to import all components for the app.

These modules we require are almost decoupled from all other modules and thus can be moved into any other application with ease. Finally there is an explicit dependency between the modules, because there is not a dependency injection system.

// components.module.js
import "./header/header.module.js";
import "./toasts/toasts.module.js";
import "./stats/stats.module.js";
import "./basket/basket.module.js";
import "./assets/assets.module.js";
import "./mostused/mostused.module.js";
import "./latest/latest.module.js";
import "./other/other.module.js";

Back to top

Common module

The Common module is the container reference for all application specific components, that we don't want to use in another application. This can be things like layout, navigation and footers. See above how we import common.module.js and inject them into the Root module, this gives us a single place to import all common components for the app.

// common.module.js
import "./app.module.js";

Back to top

File naming conventions

Keep it simple and lowercase, use the component name, e.g. calendar.*.js*, calendar-grid.*.js - with the name of the type of file in the middle. Use *.module.js for the module definition file, as it keeps it verbose and consistent.

calendar.module.js
calendar.component.js
calendar.controller.js
calendar.service.js
calendar.service.spec.js
calendar.template.js

Back to top

Scalable file structure

File structure is extremely important, this describes a scalable and predictable structure. An example file structure to illustrate a modular component architecture.

├── app/
│   ├── components/
│   │  ├── calendar/
│   │  │  ├── calendar.module.js
│   │  │  ├── calendar.component.js
│   │  │  ├── calendar.service.js
│   │  │  ├── calendar.service.spec.js
│   │  │  ├── calendar.template.js
│   │  │  └── calendar-grid/
│   │  │     ├── calendar-grid.module.js
│   │  │     ├── calendar-grid.component.js
│   │  │     ├── calendar-grid.controller.js
│   │  │     ├── calendar-grid.template.js
│   │  ├── events/
│   │  │  ├── events.module.js
│   │  │  ├── events.component.js
│   │  │  ├── events.service.js
│   │  │  ├── events.template.js
│   │  │  └── events-signup/
│   │  │     ├── events-signup.module.js
│   │  │     ├── events-signup.component.js
│   │  │     ├── events-signup.service.js
│   │  │     ├── events-signup.service.spec.js
│   │  │     ├── events-signup.template.js
│   │  └── components.module.js
│   ├── common/
│   │  ├── nav/
│   │  │     ├── nav.module.js
│   │  │     ├── nav.component.js
│   │  │     ├── nav.service.js
│   │  │     ├── nav.sevice.spec.js
│   │  │     ├── nav.template.js
│   │  ├── footer/
│   │  │     ├── footer.module.js
│   │  │     ├── footer.component.js
│   │  │     ├── footer.service.js
│   │  │     ├── footer.service.spec.js
│   │  │     ├── footer.template.js
│   │  └── common.module.js
│   │  └── app.module.js
│   │  └── app.template.js
│   │  └── app.component.js
│   │  └── app.css
│   ├── root.module.js
│   ├── root.component.js
│   └── root.template.js
└── index.html

The rationale behind this structure is a separation based on feature (folders-by-feature) and not on file type (folders-by-type).

The high level folder structure simply contains index.html and app/, a directory in which all our root, component, common and low-level modules live along with the markup and styles for each component.

Back to top

Components

Component theory

Components are essentially templates with a controller.

The component is bootstrapped in the module file.

// assets.module.js

import { AssetsComponent } from "./assets.component.js";

AssetsComponent.bootstrap();

In the component it is defined the tag used in the markup and it is created the controller instance.

// assets.component.js
import { Util } from "../../util.js";
import { AssetsTemplate } from "./assets.template.js";
import { AssetsController } from "./assets.controller.js";

export class AssetsComponent {
    static bootstrap() {
        const render = hyperHTML.bind(Util.query("assets"));

        this.assetsController = new AssetsController(render, AssetsTemplate);
    }

    static update() {
        this.assetsController.update();
    }
}

Generally speaking, the component interface contains only the bootstrap api, but when the component is updated from another one, there is also an update api, eventually passing the new state.

Note

There are different approaches how to create a component, described in the docs, and based on hyper.Component and HyperHTMLElement. This topic would deserve a complete dedicated section.

Back to top

Controllers

Controllers should only be used alongside components, never anywhere else. If you feel you need a controller, what you really need is likely a stateless component to manage that particular piece of behaviour. Basically a controller contains the logic of the user actions in the template.

// asset.controller.js
import { Util } from "../../util.js";
import { AssetsService } from "./assets.service.js";
import { BasketComponent } from "../basket/basket.component.js";
import { StatsComponent } from "../stats/stats.component.js";
import { ToastsComponent } from "../toasts/toasts.component.js";

export class AssetsController {
    constructor(render, template) {
        this.render = render;
        this.template = template;
        this.events = (e, payload) => Util.handleEvent(this, e, payload);
        this.state = {
            // cut
        };

        this.update();
    }

    update() {
        // cut

        this.template.update(this.render, this.state, this.events);
    }

    onAssetClick(e, item) {
        // cut
    }
}

So render and templates are passed by the component instance. The controller passes events and state to the template.

You may use an observer pattern, intending to update automagically the template, when the state is modified.

// activity.controller.js
export class ActivityController {
    constructor(render, template) {

        this.state = Introspected({
            activities: []
        }, state => template.update(render, state));

        this.activityService = new ActivityService(this.state.activities);
    }
}

If you use a third party lib (for instance Introspected), watching an object or array for changes, the state (or a slice of the state) is passed to the service. Finally, when the component (or other ones) change the properties in the model, using the service methods, the template is update.

Stretching a bit further this approach, you may use a state container.

Back to top

Templates

// basket.template.js
import { Util } from "../../util.js";

export class BasketTemplate {
    static update(render, state, events) {
        const showBasketTable = Util.show(state.assetsSearch.length);
        const tableClasses = `${showBasketTable} f7 mw8 pa2`;
        const headerClasses = "fw6 bb b--black-20 tl pb1 pr1 bg-black-10";
        const trClasses = "pv1 pr1 bb b--black-20";
        const trClassesLink = `${trClasses} pointer dim`;

        /* eslint-disable indent */
        render`
            <h2>Basket</h2>

            <div class="pa2 w5">
                <input id="assetsSearch" oninput="${events}"
                    class="pa2 w5"
                    placeholder="What assets to be added?">
            </div>
            <table class="${tableClasses}">
                <thead>
                    <th class="${headerClasses}">Symbol</th>
                    <th class="${headerClasses}">Description</th>
                    <th class="${headerClasses}">Type</th>
                    <th class="${headerClasses}">Market</th>
                </thead>

                <tbody>${state.assetsSearch.map(asset => {
                    const id = `assetSearch-${asset.symbol}`;

                    return hyperHTML.wire()`<tr>
                        <td id="${id}" onclick="${e => events(e, asset)}"
                            class="${trClassesLink}"
                            title="Click to add the asset">${asset.symbol}</td>
                        <td class="${trClasses}">${asset.name}</td>
                        <td class="${trClasses}">${asset.type}</td>
                        <td class="${trClasses}">${asset.exchDisp}</td>
                    </tr>`;
                })}</tbody>
            </table>
        `;
        /* eslint-enable indent */
    }
}

The css classes are embedded in the template, a literal template, with wire partials.

<input id="assetsSearch" oninput="${events}" ...

The event handler is automagically onAssetsSearchInput due to Util.handleEvent.

const id = `assetSearch-${asset.symbol}`;

Be aware partial attributes are not allowed. It is better to create a variable to use in the template.

<td id="${id}" onclick="${e => events(e, asset)}" ...

The event handler is onAssetSearchClick and asset is its payload.

Back to top

Services

Services are essentially containers for business logic that our components shouldn't request directly.

// assets.service.js
import { LatestComponent } from "../latest/latest.component.js";

const CONPA_ASSETS = "conpa.assets";

export class AssetsService {
    static getAssets() {
        return AssetsService.assets;
    }

    static addAsset(item) {
        const assets = AssetsService.assets;
        const isNew = assets
            .filter(asset => item.symbol === asset.symbol)
            .length === 0;

        if (isNew) {
            assets.push(item);
        }

        return isNew;
    }

    static removeAsset(item) {
        const assets = AssetsService.assets;
        let isRemoved = false;

        assets.forEach((asset, index) => {
            if (item.symbol === asset.symbol) {
                assets.splice(index, 1);
                isRemoved = true;
            }
        });

        return isRemoved;
    }

    static getLastAsset() {
        return AssetsService.assets.slice(-1)[0];
    }

    static saveAssets() {
        localStorage.setItem(CONPA_ASSETS, JSON.stringify(AssetsService.assets));
    }

    static calcOptimalPortfolioYOY() {
        const refDate = new Date(new Date().getTime() - (1000 * 60 * 60 * 24 * 365));

        return AssetsService.calcOptimalPortfolio({
            referenceDate: refDate.toString()
        });
    }

    static calcOptimalPortfolio({ referenceDate = new Date().toString() } = {}) {
        return workway("node://finance.js").then(async({ namespace: finance }) => {
            const lows = [];
            const highs = [];

            const prods = AssetsService.assets.map((asset, index) => {
                lows[index] = 0;
                highs[index] = -1;

                return asset.symbol;
            });

            const ptfParams = {
                prods,
                referenceDate,
                targetReturn: null,
                lows,
                highs
            };

            return finance.getOptimalPortfolio(ptfParams).then(res => {
                if (res.message) {
                    throw new Error(res.message);
                }

                finance.savePortfolio({
                    symbols: prods,
                    weights: res.optim.solution,
                    ref: referenceDate,
                    ret: res.optim.pm,
                    risk: res.optim.ps,
                    perf: res.perf,
                    highs,
                    lows
                }).then(() => {
                    LatestComponent.update();
                });

                return res;
            }).catch(err => {
                throw new Error(err);
            });
        });
    }
}

AssetsService.assets = JSON.parse(localStorage.getItem(CONPA_ASSETS)) || [];

Note

Here, in this service, there is an example of workway approach: it is a general purpose, Web Worker driven, remote namespace with classes and methods.

Back to top

Utils

The following utilities allow to improve the error handling and, finally, to generalize the event handling for different targets.

// utils.js
export class Util {
    static query(selector) {
        return document.querySelector(selector) ||
            console.error(selector, "not found");
    }

    static handleEvent(context, e, payload) {
        const type = e.type;
        const id = e.target.id || console.warn(e.target, "target without id");
        const method = `on${id[0].toUpperCase()}${id.split("-")[0].slice(1)}` +
            `${type[0].toUpperCase()}${type.slice(1)}`;

        const fn = (method in context && context[method]) ||
            (method in context.constructor && context.constructor[method]);

        return fn ? fn(e, payload) : console.warn(method, "not implemented");
    }
}

query wraps document.querySelector and logs an error if it is not found the tag element, generally speaking because we forgot to add it to the markup or due to a typo. Also it helps to identify bootstrapping order errors, intending a component is bootstrapped before its tag is added to the DOM, like a child before its parent, because the selector contains the parent reference.

handleEvent() method is called by the user agent when an event is sent to the EventListener, in order to handle events that occur on an observed EventTarget.

In the controller events is defined and it is passed to the template.

// foo.controller.js
this.events = (e, payload) => Util.handleEvent(this, e, payload);
...
this.template.update(this.render, this.state, this.events);

So events can be used in the template with or without a payload.

// foo.template.js
<input id="assetsSearch" oninput="${events}" ...
...
<td id="${id}" onclick="${e => events(e, asset)}" ...

Any tag with an event listener needs an id and logs an error if it is not found, because the name of the controller method is based on the id name and the type of the event handler, following these rules:

on adds a prefix.
id[0].toUpperCase() gets the first character of id and converts to uppercase.
id.split("-")[0].slice(1) splits the id, finally based on -, gets the first part and removes the first character. This trick is a useful when you have a list of tags and the event listener is the same. Generally speaking, inside the method you have some logic based on the event target or, better, you passed different payloads.
${type[0].toUpperCase() gets the first character of the event listener type and converts to uppercase.
type.slice(1) gets the rest of the event listener type.

For an input element with id assetsSearch, the method called is onAssetsSearchInput.

For a td element with id asset-IBM and click event, the method called is onAssetClick.

Back to top

How To

The examples show how to follow the styleguide applied to a few concrete use cases.

A Modal Dialog

Live example.

There is a generic component foo, opening a very simple modal dialog, bar.

    <foo></foo>
    <bar-dialog></bar-dialog>

In the page there are the tags for the component and for the dialog.

// foo.component.js
class FooComponent {
    static bootstrap() {
        const render = hyperHTML.bind(Util.query("foo"));

        this.fooController = new FooController(render, FooTemplate);
    }
}

FooComponent.bootstrap();

The controller contains not only the state of the component, but also the state of the dialog, this.state.barModal. Eventually two event handlers are implemented in the controller, onOpenBarModalFromFooClick and onCloseBarModalClick.

The events of the controller and this.state.barModal is passed to the modal component, becoming its state.

// foo.controller.js
class FooController {
    constructor(render, template) {
        this.render = render;
        this.template = template;
        this.events = (e, payload) => Util.handleEvent(this, e, payload);
        this.state = {
            barModal: {
                isOpen: false,
                headerName: "Bar Modal from Foo",
                answer: ""
            }
        };

        this.update();

        this.barModalComponent = new BarModalComponent(this.state.barModal, this.events);
    }

    update() {
        this.template.update(this.render, this.state, this.events);
    }

    displayModalAnswer(text) {
        this.state.barModal.answer = text;
        this.update();
        setTimeout(() => {
            this.state.barModal.answer = "";
            this.update();
        }, 2000);
    }

    onOpenBarModalFromFooClick() {
        this.state.barModal.isOpen = true;
        this.update();
        this.barModalComponent.update();
    }

    onCloseBarModalClick(e, res) {
        this.displayModalAnswer(res.answer);
        this.barModalComponent.update();
        this.update();
    }
}

The modal component is bootstrapped with new BarModalComponent(...) and not with the usual bootstrap api, because we may have more instances of the dialog.

// foo.template.js
class FooTemplate {
    static update(render, state, events) {
        render`
            <button id="openBarModalFromFoo" type="button" onclick="${events}">
                Open Bar Dialog from Foo
            </button>

            <p>${state.barModal.answer}</p>
        `;
    }
}

The modal component, as said, is not a singleton and, apart the usual render and template parameters, are passed also state and events ones, objects corresponding to the controller of the parent: they are useful to communicate with the parent.

// bar-modal.component.js
class BarModalComponent {
    constructor(state, events) {
        const render = hyperHTML.bind(Util.query("bar-dialog"));

        this.barModalController = new BarModalController(render, 
            BarModalTemplate, state, events);
    }

    update() {
        this.barModalController.update();
    }
}

The controller of the modal is only here as a pass-through to the template.

// bar-modal.controller.js
class BarModalController {
    constructor(render, template, state, events) {
        this.render = render;
        this.template = template;
        this.state = state;
        this.events = events;

        this.update();
    }

    update() {
        this.template.update(this.render, this.state, this.events);
    }
}

// bar-modal.template.js
class BarModalTemplate {
    static update(render, state, events) {
        if (!state.isOpen) {
            render``;

            return;
        }

        /* eslint-disable indent */
        render`
            <div class="fixed absolute--fill bg-black-70 z5">
            <div class="fixed absolute-center z999">

            <main class="pa4 black-80 bg-white">
                <form class="measure center">
                    <fieldset class="ba b--transparent ph0 mh0">
                        <legend class="f4 fw6 ph0 mh0 center">${state.headerName}</legend>
                    </fieldset>

                    <div class="flex flex-row items-center justify-around">
                        <button id="closeBarModal" type="button"
                            onclick="${e => {
                                state.isOpen = false;
                                events(e, { answer: state.headerName });
                            }}">Close Bar Dialog
                        </button>
                    </div>
                </form>
            </main>

            </div>
            </div>
        `;
        /* eslint-enable indent */
    }
}

Back to top

Made with hyperHTML

Argo, a forex trading platform.
ConPA, an asset allocation app.

Back to top

Resources

Back to top

Documentation

For anything else, including API reference, check the hyperHTML documentation.

Back to top

Contributing

Open an issue first to discuss potential changes/additions.

Back to top

Credits

@WebReflection for creating hyperHTML.
@toddmotto for the original styleguide (AngularJS styleguide, a masterpiece) and for the great posts on AngularJS.
@john_papa for the first styleguide (Angular 1 Style Guide) I read how to structure a web application.

Back to top

License

albertosantini/hyperhtml-styleguide

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages