A collection of beautifully designed, accessible, and customizable terminal UI components. Built on Ink. Works with shadcn/ui.

How do I publish components with termcn?

Add or edit components under registry/bases/ink/ or registry/bases/opentui/, register them in registry.json, run pnpm registry:build (which refreshes public/r/), then deploy. Consumers install with npx shadcn@latest add against your published registry URL.

Is termcn open source?

Yes. The source is on GitHub and released under the MIT License.

Tooltip

Contextual tooltip on focus or hover

Terminal

tooltip-demo

No opentui live preview is registered for this example yet.

Installation


$ pnpm dlx shadcn@latest add @termcn/tooltip

Usage

import { Tooltip } from "@/components/ui/tooltip";

<Tooltip content="Save your current progress" position="top" isVisible={true}>
  <Text bold>[S] Save</Text>
</Tooltip>

API Reference

Prop	Type	Default
`children`	`ReactNode`	`required`
`content`	`string`	`required`
`position`	`"top" \| "bottom" \| "left" \| "right"`	`"top"`
`isVisible`	`boolean`	`false`
`borderStyle`	`"single" \| "double" \| "round" \| "bold" \| "singleDouble" \| "doubleSingle" \| "classic"`	`"single"`
`borderColor`	`string`	-
`paddingX`	`number`	`1`
`paddingY`	`number`	`0`
`gap`	`number`	`1`
`arrowDown`	`string`	`"↓"`
`arrowUp`	`string`	`"↑"`

Popover Forms

On This Page

Installation Usage API Reference Tooltip

Edit this page Follow @shadcnlabs Join community