flagstaff/box

import { box, boxComponent } from 'flagstaff/box';

function box(text: string, options?: BoxOptions): string;

function boxComponent(options?: BoxOptions): Component<BoxState>;

interface BoxOptions {
    /** A registered border's name, or a style of your own. Default `round`. */
    border?: string | BorderStyle;
    /** Cells of padding left and right of the text, and rows above and below. Default 1 / 0. */
    padding?: {
        x?: number;
        y?: number;
    };
    /** A title written into the top border. Truncated with `…` if the box is too narrow. */
    title?: string;
    /** Columns the whole box may occupy, borders included. Text wraps to fit. Default 80. */
    width?: number;
    /**
     * A url or a path the box's text points at — `file://…` for a path a terminal should be
     * able to open, which is the case R12 is named after. The title is left alone: it is a
     * label for the box, and a link around it would claim the border is clickable too.
     */
    href?: string;
    /**
     * The terminal the link is rendered for. Omitted, the real process is read through this
     * package's seam. Supply one and the whole path is pure.
     */
    terminal?: Terminal;
}

interface BoxState {
    text: string;
    title?: string;
    /** Per-state destination, overriding the one the component was built with. */
    href?: string;
}

type Terminal = Parameters<typeof linkFor>[0];