README.md

@prairielearn/html

Utilities for easily rendering HTML from within JavaScript.

Usage

The html tagged template literal can be used to render HTML while ensuring that any interpolated values are properly escaped.

By convention, HTML templates are located in *.html.ts files.

// Hello.html.ts
import { html } from '@prairielearn/html';

export function Hello({ name }: { name: string }) {
  return html`<div>Hello, ${name}!</div>`;
}

This can then be used to render a string:

import { Hello } from './Hello.html.ts';

console.log(Hello({ name: 'Anjali' }).toString());
// Prints "<div>Hello, Anjali!</div>"

Using escaped HTML

If you want to pre-escape some HTML, you can wrap it in escapeHtml to avoid escaping it twice. This is useful if you want to inline some HTML into an attribute, for instance with a Bootstrap popover.

import { html, escapeHtml } from '@prairielearn/html';

console.log(html`
  <button data-bs-toggle="popover" data-bs-content="${escapeHtml(html`<div>Content here</div>`)}">
    Open popover
  </button>
`);

Why not EJS?

In the past, PrairieLearn used EJS to render most views. However, using a tagged template literal and pure JavaScript to render views has a number of advantages:

• Prettier will automatically format the content of any html tagged template literal; EJS does not have any automatic formatters.
• Authoring views in pure JavaScript allows for easier and more explicit composition of components.
• It's possible to use ESLint and TypeScript to type-check JavaScript views; EJS does not offer support for either.