Sections

@calvinbonner/minifw API Reference

Version 0.2.1

core/config

type-alias MiniConfig

type MiniConfig = {
  document?: MiniDocumentOptions;
  globalStyles?: MiniGlobalStyles;
  htmx?: MiniHtmxConfig | false;
  runtime?: boolean;
  scripts?: MiniScripts;
};

Document and browser behavior owned by mini.

property document

Configuration for MiniFW's generated document scaffold.

MiniDocumentOptions

property globalStyles

Global CSS included in full-page documents.

MiniGlobalStyles

property htmx

HTMX loading configuration. Set to false to omit HTMX.

MiniHtmxConfig | false

property runtime

Enables MiniFW's runtime for promoted scoped styles. Defaults to true.

boolean

property scripts

Global scripts included in full-page documents.

MiniScripts

type-alias MiniDocumentHeadArguments

type MiniDocumentHeadArguments = {
  context: MiniContext;
  head?: MiniHead;
};

Arguments received by the optional document head renderer.

property context

MiniContext

property head

Metadata supplied by the matched page.

MiniHead

type-alias MiniDocumentOptions

type MiniDocumentOptions = {
  bodyAttributes?: Record<string, string | undefined>;
  head?: object;
  htmlAttributes?: Record<string, string | undefined>;
};

Configuration for the HTML document generated by mini.

property bodyAttributes

Attributes written on the generated <body> element.

Record<string, string | undefined>

property head

Additional tags written into the generated <head>.

object

property htmlAttributes

Attributes written on the generated <html> element.

Record<string, string | undefined>

type-alias MiniHtmxConfig

type MiniHtmxConfig = { type: "cdn"; version: string | number } | { loadFn: object; type: "local" };

HTMX loading strategy configured for the MiniFW document.

{ type: "cdn"; version: string | number } | { loadFn: object; type: "local" }