htmx-bun is a Hypermedia Server hosted on the Bun runtime with Htmx as a first-class integration.

Status: pre-alpha

Mission:

To make building web sites fast, fun, and uncomplicated.

Influences:

1. HATEOAS
2. Hypermedia Systems

Design principles:

1. All views are partials
2. Partials are a mix of script and html.
3. Partials are accessible by route.
4. Partials emit html, or nothing.
5. Partials are composable.

Run an example

git clone https://github.com/moonlight-pm/htmx-bun
cd htmx-bun
bun i
bun examples:todo

Start fresh

mkdir my-project && cd my-project
bunx htmx-bun

Now, start dropping files in the public directory.

Partials

Partials are indicated with the extension .part. Partials consist of both script and html. You may start the file with some script, but as soon as a newline followed by a tag or docytype is encountered, html will be assumed from then on.

Example:

const a = 1;
const b: string = "b";

<div>{a}</div>
<div>{b}</div>

Partials will be resolved into tagnames based on their path.

Examples:

• /view/index.part → <root />
• /view/todo.part → <todo />
• /view/todo/list.part → <todo-list />

These tags may be referenced in other partials.

Tag attributes are passed in as attributes normally are, and are available in the script. If you include an interface, the types will be properly coerced.

Example:

interface Attributes {
    page: number;
}

// Available in the script section on the Attributes object.
console.log(Attributes.page);

<div>{typeof page}</div>

<!-- Output:
    <div>number</div>
-->

Attributes can also be passed in if the partial/tag is loaded via GET:

GET /todo?id=1

More documentation is in the works.