Terminal

REACT · Terminal

import { Terminal } from "@chrishayuk/hause/components/forms/Terminal";

export type TerminalLine = {
	text: string;
	tone?: "accent" | "dim" | "err" | "ok";
	/** Renders the line as a link — the terminal's door into the rest of the site. */
	href?: string;
};

export type TerminalResult = {
	lines: TerminalLine[];
	/** A designed object rendered beneath the lines, with its RAW proof. */
	panel?: TerminalPanel;
	/** Reset the scrollback to the banner instead of appending. */
	clear?: boolean;
	/** Play the refusal sound instead of the tick. */
	refused?: boolean;
};

export function Terminal({
	kicker,
	headline,
	banner,
	prompt = ">",
	seeds = [],
	execute,
	complete,
	autorun,
	notice,
	sessionKey,
	height = 420,
	clearLabel = "CLEAR",
	fallback,
	footnote,
}: {
	/** Evidence-voice label above the instrument. */
	kicker: string;
	/** Editorial-voice line, e.g. "psql, for a model." */
	headline?: string;
	/** The lines a fresh session opens with — also what CLEAR restores. */
	banner: TerminalLine[];
	/** The prompt string, caller-owned (may change between lines). */
	prompt?: string;
	/** One-click statements rendered as chips under the terminal. */
	seeds?: string[];
	/** The meaning of the terminal: one line in, lines out. */
	execute: (line: string) => Promise<TerminalResult> | TerminalResult;
	/** Tab completion: candidate continuations for the current input. */
	complete?: (line: string) => string[];
	/** A command run once on mount — deep links into the terminal. */
	autorun?: string;
	/** Appended (not reset) when it changes — e.g. a transport coming live. */
	notice?: TerminalLine;
	/** When this changes, the scrollback resets to the current banner. */
	sessionKey?: string | number;
	height?: number;
	clearLabel?: string;
	/** System-voice sentences that survive with the interaction removed. */
	fallback?: string;
	/** Evidence-voice closing line. */
	footnote?: string;
})

The import and the complete props contract. For installation and composition, follow the Build guide.