frontend-si

v1.0.1

Published

3 years ago

Fast, lightweight and minimalist frontend framework

Downloads

0High
0Medium
0Low

mlsc-apps

si frontend express framework web html web page http rest

frontend-si is fast, lightweight and minimalist frontend framework based on model-view-controller design pattern properly separating rendering from the data. Every line in template file will follow the same pattern:

renderer[@->data]

which will execute defined renderer after passing input data to it.

Hello World (with nodejs/express)

Create template file hello.si with following content

html
    head
    body
        div@->message

html, head, body are built-in renderers with no data passed to them. div is a built-in renderer to which we will pass data object called message.

Make sure to import frontend-si module and in your express app file

import { Si } from 'frontend-si';

and add following line to handle request at root:

app.get('/', function(req, res) {
    Si.renderHTML('./hello.si', { message : "Hello World!" }, (html) => {
        res.status(200).send(html);
    });
});

This will return following rendered html file:

<html><head></head><body><div>Hello World!</div></body></html>

Renderers

There are three types of renderers which will be resolved in following order:

Local renderers. Framework will try to resolve local renderers as first. Framework will look into special folder renderers in the root directory and then inside folder with renderer name and then it will look for a special file called render.js for rendering instructions.
For example renderer with name list-1.0 will be resolved for instructions under: ./renderers/list-1.0/render.js
Example usage in template file:
list-1.0@->listData
Remote renderers. If not resolved locally framework will check for https:// in the name of renderer to assume this is remote renderer. Framework will download the content of remote renderer and cache it inside renderer folders giving it a name based on URL. Next time it will be resolved locally. Feel free to change it locally if required if you want to pull remote file again just delete the folder with remote renderer.
Example usage in template file:
https://raw.githubusercontent.com/mlsc-apps/si-renderers/master/list-1.0/render.js@->listData
:warning: WARNING: Make sure to review the renderer first before using in your templates. There is enough dishonest actors to try to make damage and in the end you are executing someone else code.:warning:
Built-in renderers. If not resolved locally and remotely framework will fall back to built-in renderers. This means if you are not happy with default behaviour of built-in renderers write your own local one and this will override the built-in behaviour.

Simple remote renderers

Of course the biggest power of the framework lies in remote renderers since they can be written by experts and shared. There are couple of simplest, ready-to-go remote renderers to experiment with: https://github.com/mlsc-apps/si-renderers.

You would use them by pointing to the raw version of the file for example: https://raw.githubusercontent.com/mlsc-apps/si-renderers/master/table-1.0/render.js@->myOwnTableData

Css

You can pass css information same as any other data. Good practice would be to add css parameter inside data object for all style related information. If you pass a style to render to use make sure to add a css link in the header section of the template where the css class is defined.

Writing your own renderer

Create a folder with renderer name under special folder renderers.

.
|-> renderers
    |-> myFirstRenderer

Create a special file inside renderers folder called render.js

.
|-> renderers
    |-> myFirstRenderer
        |-> render.js

Implement render specification in the file render.js as follows (class name does not matter)

class MyFirstRenderer {
    
    beginRender(data) {
        return '';
    }

    endRender(data) {
        return '';
    }
}

Framework will execute methods beginRender and endRender accordingly. Data required to generate html will be provided in data object.

Once implemented you can use new renderer inside your templates:
MyFirstRenderer@->data

Example project

There is a working nodejs/express example here: https://github.com/mlsc-apps/frontend-si-example

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Hello World (with nodejs/express)

Renderers

Simple remote renderers

Css

Writing your own renderer

Example project