# simple-html-template-tag

> Simple utility for generating safe HTML.

Latest version **0.0.5** (published 2023-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-html-template-tag
pnpm add simple-html-template-tag
yarn add simple-html-template-tag
bun add simple-html-template-tag
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2023-01-25 |
| First published | 2023-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joshua Shaffer |
| Maintainers | joshuatshaffer |

## Links

- npm: https://www.npmjs.com/package/simple-html-template-tag
- Repository: https://github.com/joshuatshaffer/html-template-tag
- Homepage: https://github.com/joshuatshaffer/html-template-tag#readme
- Issues: https://github.com/joshuatshaffer/html-template-tag/issues
- npm.io page: https://npm.io/package/simple-html-template-tag

## Recent versions

- 0.0.5 (latest) — 2023-01-25
- 0.0.4 — 2023-01-19
- 0.0.3 — 2023-01-19
- 0.0.2 — 2023-01-19

## README

# Simple HTML Template Tag

Simple utility for generating safe HTML. Escapes interpolated values and supports nesting templates.

## Installation

```sh
npm install --save simple-html-template-tag
```

```sh
yarn add simple-html-template-tag
```

```sh
pnpm add simple-html-template-tag
```

```js
import { html } from "simple-html-template-tag";

console.log(html`<p>Hello, ${"world"}!</p>`.toString());
```

## Overview

Automatically escapes strings which helps prevent code injection.

```ts
html`<h1>${"Family & Friends"}</h1>`.toString();
```

```html
<h1>Family &amp; Friends</h1>
```

Renders `null` and `undefined` as empty strings.

```ts
html`<h1>Foo${null}Bar${undefined}Baz</h1>`.toString();
```

```html
<h1>FooBarBaz</h1>
```

Renders arrays by rendering each of their elements. This also works on deep arrays.

```ts
html`<h1>${["zero", 1, 2, null, ["a", "b"], "Last"]}</h1>`.toString();
```

```html
<h1>zero12abLast</h1>
```

The result of an HTML template can be used in another HTML template.

```ts
// This will be escaped because it's a string.
const who = "me & the boys";
// However, this will not be escaped because it uses the html template tag.
const what = html`looking for <strong>beans</strong>`;

html`<p>${who} at 2am ${what}</p>`.toString();
```

```html
<p>me &amp; the boys at 2am looking for <strong>beans</strong></p>
```

Objects can implement the implement their own HTML rendering logic.

```ts
import { html, toHtml, type ToHtml } from "simple-html-template-tag";

class Weather implements ToHtml {
  constructor(public condition: string, public tempF: number) {}

  [toHtml]() {
    return html`<img
        src="/assets/${this.condition}.png"
        alt="${this.condition}"
      />
      ${this.tempF} &deg;F`;
  }
}

html`<div>Today&quot;s forecast: ${new Weather("sunny", 78)}</div>`.toString();
```

```html
<div>
  Today&quot;s forecast: <img src="/assets/sunny.png" alt="sunny" /> 78 &deg;F
</div>
```

## Editor Integrations

This library works with several of the tools built for [lit-html](https://www.npmjs.com/package/lit-html).

[Prettier](https://www.npmjs.com/package/prettier) will automatically format template literals tagged with `html`. No extra config is needed.

The [lit-html plugin for VSCode](https://marketplace.visualstudio.com/items?itemName=bierner.lit-html) provides good syntax highting and IntelliSense.

---
_Source: https://npm.io/package/simple-html-template-tag · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
