Sections

@calvinbonner/minifw API Reference

Version 0.2.1

core/layout

interface MiniLayout

interface MiniLayout {
  pageTarget: string;
  render(arguments_: LayoutRenderArguments): MaybePromise<string>;
}

A route-scoped shell that wraps nested layout or page content.

property pageTarget

CSS selector for the nested page container swapped after boosted navigation.

string

method render

render(arguments_: LayoutRenderArguments): MaybePromise<string>

type-alias LayoutOptions

type LayoutOptions = {
  pageTarget?: string;
};

Options for layout.

property pageTarget

CSS selector for the nested page container swapped after compatible boosted navigation. Defaults to "body".

string

type-alias LayoutRenderArguments

type LayoutRenderArguments = {
  context: MiniContext;
  page: string;
};

Arguments received by a route layout render function.

property context

MiniContext

property page

The pre-rendered nested layout or page HTML.

string

function layout

layout(body: BodyRenderFunction, options?: LayoutOptions): MiniLayout

Create a route-scoped layout shell.

MiniFW composes matching layouts around a page and generates the document scaffold through mini.

body

Renders the nested route or page content.

options

LayoutOptions.

Returns:

A new MiniLayout instance.