5Sponsor

Scroll View

Scrollable container with scrollbar

Terminal
scroll-view-demo
No opentui live preview is registered for this example yet.

Installation

pnpm dlx shadcn@latest add @termcn/scroll-view

Usage

import { ScrollView } from "@/components/ui/scroll-view";
<ScrollView height={5} contentHeight={20}>
  <Text>Line 1</Text>
  <Text>Line 2</Text>
  <Text>Line 3</Text>
</ScrollView>

Examples

Scrollbar and keys

Set contentHeight to the total line count of scrollable content so the thumb size reflects how much is hidden. Use arrow keys, Page Up/Down, Home, and End to scroll.

Terminal
scroll-view-scrollbar
No opentui live preview is registered for this example yet.

API Reference

ScrollView

PropTypeDefault
heightnumberrequired
childrenReactNoderequired
contentHeightnumber0
showScrollbarbooleantrue
scrollbarColorstringundefined
thumbColorstringundefined
trackCharstring"│"
thumbCharstring"█"