Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/faranalytics/js-html-renderer
A JS DSL for rendering HTML on the client or the server.
https://github.com/faranalytics/js-html-renderer
html javascript rendering template-engine template-language
Last synced: about 1 month ago
JSON representation
A JS DSL for rendering HTML on the client or the server.
- Host: GitHub
- URL: https://github.com/faranalytics/js-html-renderer
- Owner: faranalytics
- License: mit
- Created: 2024-02-17T18:55:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-21T04:32:48.000Z (11 months ago)
- Last Synced: 2024-11-16T04:47:04.408Z (about 2 months ago)
- Topics: html, javascript, rendering, template-engine, template-language
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/js-html-renderer
- Size: 136 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JS HTML Renderer
A JS DSL for rendering HTML on the client or the server.
## Introduction
The JS HTML Renderer provides a concise and intuitive syntax for writing HTML using JavaScript. You can use the Renderer in order to create a static `Template` and inject dynamic content into it. JS [Symbols](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) are used in order to designate where dynamic content will be inserted.
The Renderer's syntax is intuitive and concise e.g.,
```ts
const template: Template = doctype()(
html()(
head()(
title()('The Title'),
// ⮴ The element collection may contain text nodes or elements.
script({ src: 'script.js' })()
// ⮴ Attributes are defined using key-value pairs.
),
body()(
main({ id: 'main-content' })(
br(),
// ⮴ Void elements lack parens for a node collection.
p()(
$greetings // 🢤 `$greetings` is a JS Symbol.
// ⮴ Dynamic content may be injected wherever there is a Symbol.
)
)
)
)
);
```
### Features
- An intuitive and concise syntax.
- Create custom HTML tags (i.e., for [Custom Elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements)).
- Performant [prerendering](#prerendering).
- Use the prettier of your choice for beautifying your HTML.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Performance](#performance)
- [Custom HTML Tags](#custom-html-tags)
- [Hello, World! Example](#hello-world-example)
## Installation
```bash
npm install js-html-renderer
```
## Usage
In this example you will create an HTML document that contains greetings in Esperanto and English.
### Import typings and relevant tags.
```ts
import { Template, doctype, html, head, body, main, ul, li } from "js-html-renderer";
```
### Create a `Symbol` variable for injection of dynamic content.
```ts
const $greetings = Symbol('greetings');
```
### Create an HTML `Template`.
You will use the `Symbol` created above in order to designate where dynamic content will be inserted.
```ts
const template: Template = doctype()(
html()(
head()(
),
body()(
main({ id: 'main-content' })(
$greetings
// ⮴ You will insert an unordered list of greetings here.
)
)
)
);
```
### Create an HTML list of greetings using JavaScript.
You use JavaScript and the Renderer's HTML elements in order to produce dynamic content. In this example you use `Array.prototype.map` in order to map the elements of `helloWorld` into a list of `li` elements.
```ts
const helloWorld = ['Saluton, Mondo!', 'Hello, World!'];
const greetings = ul({ id: 'greetings' })(
helloWorld.map(
(greeting: string, index: number) => li({ id: `greeting-${index}` })(greeting)
// This is an HTML `li` element. ⮵
// Each `li` element will contain its respective `id` attribute.
)
);
```
#### The `greetings` HTML fragment looks like this when rendered (formatted for clarity):
```html
- Saluton, Mondo!
- Hello, World!
```
### Inject the dynamic content and render the HTML.
You use `template.render` in order to inject the unordered HTML list of `greetings` created above into the `Template`.
```ts
const htmlText = template.render(
{
[$greetings]: greetings
}
);
```
### Log the result to the console.
```ts
console.log(htmlText);
```
#### The resulting HTML (formatted for clarity).
```html
- Saluton, Mondo!
- Hello, World!
```
## Performance
### Prerendering
HTML is prerendered at the time the root `Template` object is created. The resulting `Template` object contains an array of prerendered HTML elements and JavaScript Symbols.
For example, in the implementation shown below, all the HTML elements, including the `footer`, are prerendered at the time the `Template` is created. This means that the `Template` may be reused without having to reconstruct the HTML elements that comprise it.
The final render step, invoked using `template.render`, involves a single pass over the elements of the array in order to swap out the Symbols with dynamic content and, finally, a concatenation of the resulting HTML.
```ts
const template: Template = doctype()(
html()(
head()(
),
body()(
main({ id: 'main-content' })(
$greetings
),
footer({id: 'footer'})()
)
)
);
```
## Custom HTML Tags
Custom HTML tags can be created by binding the name of the tag to the first argument of the Renderer's sigil function. The resulting HTML tag can be used as a [Custom Element](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements).
### How to create a custom HTML tag.
#### Import the Renderer's sigil function for creating custom HTML tags.
```ts
import { $ } from "js-html-renderer";
```
#### Create a custom HTML tag named `my-custom-element`.
```ts
const my_custom_element = $.bind(null, 'my-custom-element');
```
#### Render the custom element with the class name `custom-element` and content "Hello, World!" and log it to the console.
```ts
console.log(my_custom_element({ class: 'custom-element' })('Hello, World!').render());
```
##### Output
```html
Hello, World!
```
## "Hello, World!" Example
In this hypothetical example you will create a multi-lingual Greeter application. You will create an HTTP server that listens on port 3000 and serves dynamic content that contains greetings from around the world. Please see the [Hello, World!](https://github.com/faranalytics/js-html-renderer/tree/main/examples/hello_world) example for a working implementation.
### Import Node's native HTTP server, the `Template` type, relevant HTML tags, and a dictionary of "Hello, World!" greetings.
```ts
import * as http from "node:http";
import { Template, doctype, html, head, title, script, link, body, main, section, h1, ul, li, footer } from "js-html-renderer";
import { worlds } from "./hello_worlds.js";
```
### Create the `Symbol` variables and the `Template`.
Dynamic content will be injected into the `Template` at its respective `Symbol` on each request.
```ts
const $main_content = Symbol('main_content');
const $title = Symbol('title');
const $script = Symbol('script');
const $inline_script = Symbol('inline_script');
const $style_sheet = Symbol('style_sheet');
const template: Template = doctype()(
html()(
head()(
$title,
$style_sheet,
$script,
$inline_script
),
body()(
main({ id: 'main-content' })(
$main_content
),
footer({ id: 'footer' })()
)
)
);
```
### Create a function to be rendered in an inline script element.
```ts
function sayHello() {
alert('Hello, World!');
}
```
### Create the web application.
```ts
http.createServer((req: http.IncomingMessage, res: http.ServerResponse) => {
if (req.url == '/') {
// Create an unordered list of greetings.
const greetings = ul({ id: 'content' })(
Object.values(worlds).map(
(greeting: string, index: number) => li({ id: `greeting-${index}`, class: 'greetings' })(
greeting
)
)
);
// Create the content for the main section and add an inline `click` handler to the `section` element.
const html_main_content = section({ 'onClick': 'sayHello();' })(
h1()('Greetings from Around the World!'),
greetings
);
// Create a title element.
const html_title = title({ id: 'title' })('The Title');
// Create a script element.
const html_script = script({ src: './script.js' })();
// Create a link element for a stylesheet.
const html_stylesheet = link({ rel: "stylesheet", href: "styles.css" })();
//Create an inline script element.
const inline_script = script()(
sayHello.toString()
);
// Inject the dynamic materials into the `Template`.
const htmlText = template.render(
{
[$title]: html_title,
[$style_sheet]: html_stylesheet,
[$script]: html_script,
[$inline_script]: inline_script,
[$main_content]: html_main_content
}
);
res.setHeader('Content-Type', 'text/html; charset=utf-8');
res.end(htmlText);
}
else {
res.writeHead(404, '').end();
}
}).listen(3000);
```
#### Output:
# Greetings from Around the World!
- Saluton, Mondo!
- Hello Wêreld!
- Përshendetje Botë!
- ሰላም ልዑል!
- مرحبا بالعالم!
- Բարեւ աշխարհ!
- Kaixo Mundua!
- Прывітанне Сусвет!
- ওহে বিশ্ব!
- Здравей свят!
- Hola món!
- Moni Dziko Lapansi!
- 你好世界！
- Pozdrav svijete!
- Ahoj světe!
- Hej Verden!
- Hallo Wereld!
- Hello World!
- Tere maailm!
- Hei maailma!
- Bonjour monde!
- Hallo wrâld!
- გამარჯობა მსოფლიო!
- Hallo Welt!
- Γειά σου Κόσμε!
- Sannu Duniya!
- שלום עולם!
- नमस्ते दुनिया!
- Helló Világ!
- Halló heimur!
- Ndewo Ụwa!
- Halo Dunia!
- Ciao mondo!
- こんにちは世界！
- Сәлем Әлем!
- សួស្តីពិភពលោក!
- Салам дүйнө!
- ສະບາຍດີຊາວໂລກ!
- Sveika pasaule!
- Labas pasauli!
- Moien Welt!
- Здраво свету!
- Hai dunia!
- ഹലോ വേൾഡ്!
- Сайн уу дэлхий!
- မင်္ဂလာပါကမ္ဘာလောက!
- नमस्कार संसार!
- Hei Verden!
- سلام نړی!
- سلام دنیا!
- Witaj świecie!
- Olá Mundo!
- ਸਤਿ ਸ੍ਰੀ ਅਕਾਲ ਦੁਨਿਆ!
- Salut Lume!
- Привет мир!
- Hàlo a Shaoghail!
- Здраво Свете!
- Lefatše Lumela!
- හෙලෝ වර්ල්ඩ්!
- Pozdravljen svet!
- ¡Hola Mundo!
- Halo Dunya!
- Salamu Dunia!
- Hej världen!
- Салом Ҷаҳон!
- สวัสดีชาวโลก!
- Selam Dünya!
- Привіт Світ!
- Salom Dunyo!
- Chào thế giới!
- Helo Byd!
- Molo Lizwe!
- העלא וועלט!
- Mo ki O Ile Aiye!
- Sawubona Mhlaba!
#### The rendered HTML (formatted for clarity):
```html
The Title
function sayHello() {
alert('Hello, World!');
}
Greetings from Around the World!
- Saluton, Mondo!
- Hello Wêreld!
- Përshendetje Botë!
- ሰላም ልዑል!
- مرحبا بالعالم!
- Բարեւ աշխարհ!
- Kaixo Mundua!
- Прывітанне Сусвет!
- ওহে বিশ্ব!
- Здравей свят!
- Hola món!
- Moni Dziko Lapansi!
- 你好世界！
- Pozdrav svijete!
- Ahoj světe!
- Hej Verden!
- Hallo Wereld!
- Hello World!
- Tere maailm!
- Hei maailma!
- Bonjour monde!
- Hallo wrâld!
- გამარჯობა მსოფლიო!
- Hallo Welt!
- Γειά σου Κόσμε!
- Sannu Duniya!
- שלום עולם!
- नमस्ते दुनिया!
- Helló Világ!
- Halló heimur!
- Ndewo Ụwa!
- Halo Dunia!
- Ciao mondo!
- こんにちは世界！
- Сәлем Әлем!
- សួស្តីពិភពលោក!
- Салам дүйнө!
- ສະບາຍດີຊາວໂລກ!
- Sveika pasaule!
- Labas pasauli!
- Moien Welt!
- Здраво свету!
- Hai dunia!
- ഹലോ വേൾഡ്!
- Сайн уу дэлхий!
- မင်္ဂလာပါကမ္ဘာလောက!
- नमस्कार संसार!
- Hei Verden!
- سلام نړی!
- سلام دنیا!
- Witaj świecie!
- Olá Mundo!
- ਸਤਿ ਸ੍ਰੀ ਅਕਾਲ ਦੁਨਿਆ!
- Salut Lume!
- Привет мир!
- Hàlo a Shaoghail!
- Здраво Свете!
- Lefatše Lumela!
- හෙලෝ වර්ල්ඩ්!
- Pozdravljen svet!
- ¡Hola Mundo!
- Halo Dunya!
- Salamu Dunia!
- Hej världen!
- Салом Ҷаҳон!
- สวัสดีชาวโลก!
- Selam Dünya!
- Привіт Світ!
- Salom Dunyo!
- Chào thế giới!
- Helo Byd!
- Molo Lizwe!
- העלא וועלט!
- Mo ki O Ile Aiye!
- Sawubona Mhlaba!
```