API Reference

Crank.js is organized into several modules, each serving a specific purpose.

Core Module

@b9g/crank

The core module contains the fundamental building blocks for creating and rendering elements.

• Functions: createElement, cloneElement, isElement
• Classes: Element, Context, Renderer
• Interfaces: RenderAdapter
• Types: Tag, Child, Children, Component, ElementValue
• Components: Fragment, Portal, Copy, Text, Raw

Async Module

@b9g/crank/async

Utilities for handling asynchronous components and lazy loading.

• Functions: lazy
• Components: Suspense, SuspenseList

DOM Module

@b9g/crank/dom

Renderer for browser DOM environments.

• Classes: DOMRenderer
• Objects: adapter, renderer

HTML Module

@b9g/crank/html

Renderer for generating HTML strings (server-side rendering).

• Classes: HTMLRenderer
• Objects: impl, renderer

Standalone Module

@b9g/crank/standalone

Template tag functions for writing JSX-like code without a build step.

• Functions: jsx, html