js/ui/preview

js/ui/preview.ts

fino:ui/preview — run one component-preview catalog in terminals and browsers.

Component families own target-neutral preview descriptors beside their implementations. This module composes those descriptors once, then passes the same VNode-producing views to the retained terminal renderer or the server-driven HTML renderer.

import { runPreviewTui } from 'fino:ui/preview';
await runPreviewTui();
import { runPreviewHtml } from 'fino:ui/preview';
await using server = runPreviewHtml({ port: 3080 });
await server.ready;

Functions

function catalogPreviews(): PreviewGroup[]

Build the complete built-in component catalog in display order.

function runPreviewTui(groups: PreviewGroup[] = catalogPreviews()): Promise<void>

Run a preview catalog as a live fullscreen terminal application.

function previewPage( groups: PreviewGroup[], selectedKey: string | null, rawArgs: Record<string, string> = {}, actions?: Map<string, (value?: string) => void>, ): string

Render a complete static HTML page for one selected preview.

function createPreviewApp(groups: PreviewGroup[] = catalogPreviews()): App

Build the live server-driven preview application without opening a listener.

function runPreviewHtml( options: { port?: number; hostname?: string; groups?: PreviewGroup[] } = {}, ): ServeServer

Listen for the live browser preview on localhost by default.