FAQ

FAQ

What runtime does TermUI need

Bun 1.3.0 or newer for development. Published packages run on Node 18+ as well.

Does TermUI use curses or C extensions

No. It is pure TypeScript. No native dependencies.

How do I scaffold a new app

bunx create-termui-app my-app
cd my-app
bun install
bun run dev

How do I add a widget to my app

Import from @termuijs/widgets or @termuijs/ui:

import { Box, Text } from '@termuijs/widgets'

Why does my widget not update on screen

Call this.markDirty() in any setter that changes what the widget renders. Without it, the renderer skips the redraw.

How do I support terminals without Unicode

Check caps.unicode from @termuijs/core. Draw Unicode box characters when true. Fall back to ASCII when false.

How do I run tests without a real terminal

Use the headless render harness in @termuijs/testing. It renders to an in-memory screen and lets you assert on the output and feed key events.

Where do I ask a question

Open a thread in Q&A Discussions.

Where do I propose a new feature

Open a thread in Ideas Discussions, or open an issue directly.