README.md

radiant

Blaze your way through HTML using the type-safety of TypeScript

• Simple: no magic templating, just regular functions and objects.
• No magic: no template magics or string based APIs
• Type-safe: by exploiting the TypeScript type system you can guard against invalid HTML and XML

Table of Contents

• Example
• Installation
• Type safety
• Why
• License

Example

import { h, renderDocument } from "@sondr3/radiant";

const doc = h.document(
  h.doctype(),
  h.html(
    h.head(
      h.meta({ charset: "utf-8" }),
      h.title("Hello, world!"),
    ),
    h.body(
      h.h1({ class: "blah" }, "Hello, world!"),
    ),
  ),
);

console.log(renderDocument(doc));

See more details and documentations at JSR.

Installation

Node

• pnpm: pnpm add @sondr3/radiant
• npm: npm add @sondr3/radiant
• yarn: yarn add @sondr3/radiant

Deno

• deno add @sondr3/radiant and import it import { h } from "@sondr3/radiant"
• Or import directly import { h } from "jsr"@sondr3/radiant"

Bun

1. bun add @sondr3/radiant
2. import { h } from "@sondr3/radiant

Type safety

import { h } from "@sondr3/radiant";

// @ts-expect-error missing href
h.a({ class: "link" }, "Missing href");

// @ts-expect-error invalid nesting
h.p(h.head(h.title("Not valid")));

Sitemaps

Also included is a very basic XML renderer with support for building and rendering sitemaps.

import { renderSitemap, s } from "@sondr3/radiant/sitemap";

const sitemap = s.document(
  s.doctype(),
  s.urlset(
    s.url(
      s.loc("http://www.example.com/"),
      s.lastmod(new Date("2005-01-01")),
      s.changefreq("monthly"),
      s.priority(0.8),
    ),
    s.url(
      s.loc("http://www.example.com/catalog?item=73&desc=vacation_new_zealand"),
      s.lastmod(new Date("2004-12-23")),
      s.changefreq("weekly"),
    ),
    s.url(
      s.loc("http://www.example.com/catalog?item=74&desc=vacation_newfoundland"),
      s.lastmod(new Date("2004-12-23T18:00:15Z")),
      s.priority(0.3),
    ),
  ),
);

console.log(renderSitemap(sitemap, { pretty: true }));

Why

After having used libraries like blaze and lucid in Haskell and smolder in PureScript, I wanted something similar in TypeScript. This is my attempt at creating a variant of them in it. It's not 100% as ergonomic in my opinion, but it's pretty close. Hence it's also named somewhat akin to blaze and smolder.

License

MIT.