Socket
Socket
Sign inDemoInstall

@ignis-web/tpl

Package Overview
Dependencies
0
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ignis-web/tpl

This library for convenient templating html and other text content in runtime without special bundlers (as Webpack and etc) or special template engine (as Pug, Handlebars and etc), only javascript


Version published
Maintainers
1
0

Weekly downloads

Readme

Source

Tpl

This library for convenient templating html and other text content in runtime without special bundlers (as Webpack and etc) or special template engine (as Pug, Handlebars and etc), only javascript. It allows to use condition operators if/else if/else and switch/case/default. The library allows you to collect html code in functional style with methods: forEach, each (forEach for object).

Install

npm i @ignis-web/tpl -S

List methods:

  • if/else/else if
  • switch/case/default
  • forEach
  • each
  • class

if/else_if/else

const tpl = require('@ignis-web/tpl');

const score = 12;
const html = `
  <div>
    ${tpl
      .if(score < 0, () => `<span>Negative: ${score}</span>`)
      .else_if(score > 0 && score < 100, () => `<span>From 0 to 100: ${score}</span>`)
      .else(() => `<span>Default: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // => <div><span>From 0 to 100: 12</span></div>

You can use only if or if/else as in usual javascript code. Example if:

let score = -10;
let html = `
  <div>
    ${tpl.if(score < 0, () => `<span>Negative: ${score}</span>`)}
  </div>
  `;
console.log(html); // => <div><span>Negative: -10</span></div>

Example if/else if:

let score = 15;
let html = `
  <div>
    ${
      tpl
      .if(score < 0, () => `<span>Negative: ${score}</span>`)
      .else_if(score > 0 && score < 100, () => `<span>From 0 to 100: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // => <div><span>From 0 to 100: 15</span></div>

Example if/else:


let score = 100;
let html = `
  <div>
    ${tpl
      .if(score < 0, () => `<span>Negative: ${score}</span>`)
      .else(() => `<span>Default: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // =>  <div><span>Default: 100</span></div>
Note:

You can pass string as second argument instead of function, if you want to use static content:

const score = 12;
const html = `
  <div>
    ${tpl
      .if(score < 0, `<span>Negative: ${score}</span>`)
      .else_if(score > 0 && score < 100, `<span>From 0 to 100: ${score}</span>`)
      .else(`<span>Default: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // => <div><span>From 0 to 100: 12</span></div>

switch/case/default

const score = 12;
const html = `
  <div>
    ${tpl
      .switch(score)
        .case(12, () => `<span>Total: ${score*2} === 24</span>`)
        .case(100, () => `<span>Total: ${score*2} === 200 </span>`)
        .default(() => `<span>Default: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // => <div><span>Total 24</span></div>

You can pass string as second argument instead of function, if you want to use static content:

const score = 100;
const html = `
  <div>
    ${tpl
      .switch(score)
        .case(12, `<span>Total: ${score} === 24</span>`)
        .case(100, `<span>Total: ${score} === 100 </span>`)
        .default(`<span>Default: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // => <div><span>Total: 100</span></div>

You can pass list as first argument in .case:

const score = 12;
const html = `
  <div>
    ${tpl
      .switch(score)
        .case([ 12, 25 ], () => `<span>Total: ${score}</span>`)
        .default(() => `<span>Default: ${score}</span>`)
    }
  </div>
  `;
console.log(html); // => <div><span>Total 12</span></div>

forEach

For rendering array:

const scores = [12, 100, 24];
const html = `
  <div>
    ${tpl.forEach(scores, (el, i) => `<p>index = ${i}, value = ${el}</p>`)}
  </div>
`;
console.log(html); // =>
/*
<div>
  <p>index = 0, value = 12</p>
  <p>index = 1, value = 100</p>
  <p>index = 2, value = 24</p>
</div>
*/

each

For rendering object:

const scores = { 'Player 1': 12, 'Player 2': 100, 'Player 3': 24 };
const html = `
  <div>
    ${tpl.each(scores, (name, score) => `<p>name = ${name}, scores = ${score}</p>`)}
  </div>
`;
console.log(html); // =>
/*
<div>
  <p>name = Player 1, scores = 12</p>
  <p>name = Player 2, scores = 100</p>
  <p>name = Player 3, scores = 24</p>
</div>
*/

class

Simple switcher for css classes on element like in Vue js:

const is_auth = true;
const html =
  `<div>
    <p ${tpl.class({ 'login-in': is_auth, 'login-out': !is_auth })}></p>
  </div>`;
);
console.log(html); // <div><p class="login-in"></p><div/>

Keywords

FAQs

Last updated on 09 Feb 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc