Card

The Card class renders a bordered box for terminal output. You give it some text, pick a width, and optionally add a title, footer, body alignment, or custom border characters. Call .render() and you get back a plain string — log it, compose it, do whatever you want with it.

Constructor

new Card(
content: string,
width?: CardWidth,
options?: CardOptions,
)

Parameters

• content — the text body. Newlines are respected and long lines are wrapped automatically.
• width — how wide the card should be. Pass a number (minimum 12, clamped to terminal width), a ratio string like "1/2" or "2/3" or "full", or "auto" to fit the content. Defaults to 50.
• options — optional config for title, body, footer, alignment, and border styling. See CardOptions.

Methods

• render() — returns the fully rendered card as a styled string. Just console.log() it.

Border Styles

Six built-in border presets are available through border.symbols.style:

• "single" — ┌ ┐ └ ┘ │ ─ (default)
• "double" — ╔ ╗ ╚ ╝ ║ ═
• "round" — ╭ ╮ ╰ ╯ │ ─
• "bold" — ┏ ┓ ┗ ┛ ┃ ━
• "singleDouble" — ╒ ╕ ╘ ╛ │ ═
• "doubleSingle" — ╓ ╖ ╙ ╜ ║ ─

You can also pass border.symbols.custom with partial or full CardBorderSymbols to use your own characters.

Usage

import { Card } from "ts-better-console";

const card = new Card("Hello, World!").render();
console.log(card);