Module: RatatuiRuby::Symbols::Scrollbar

Defined in:: lib/ratatui_ruby/symbols.rb

Overview

Scrollbar symbol sets for the Scrollbar widget.

Scrollbars need consistent visual elements: a track, a thumb, and arrow indicators. Memorizing Unicode scroll characters is tedious and error-prone.

This module exposes predefined sets with different visual styles. Use them with the Scrollbar widget to customize its appearance.

Note: Uses begin_char and end_char instead of Rust’s begin/end to avoid Ruby reserved word conflicts.

Examples

– SPDX-SnippetBegin SPDX-FileCopyrightText: 2026 Kerrick Long SPDX-License-Identifier: MIT-0 ++

# Use DOUBLE_VERTICAL for bold vertical scrollbars (default)
scrollbar = tui.scrollbar(symbols: Symbols::Scrollbar::DOUBLE_VERTICAL)

# Use VERTICAL for lighter appearance
scrollbar = tui.scrollbar(symbols: Symbols::Scrollbar::VERTICAL)

– SPDX-SnippetEnd ++

Constant Summary collapse

DOUBLE_VERTICAL = Double-line vertical scrollbar with triangle arrows.

{
  track: Line::DOUBLE_VERTICAL,
  thumb: Block::FULL,
  begin_char: "▲",
  end_char: "▼",
}.freeze

DOUBLE_HORIZONTAL = Double-line horizontal scrollbar with triangle arrows.

{
  track: Line::DOUBLE_HORIZONTAL,
  thumb: Block::FULL,
  begin_char: "◄",
  end_char: "►",
}.freeze

VERTICAL = Single-line vertical scrollbar with arrow characters.

{
  track: Line::VERTICAL,
  thumb: Block::FULL,
  begin_char: "↑",
  end_char: "↓",
}.freeze

HORIZONTAL = Single-line horizontal scrollbar with arrow characters.

{
  track: Line::HORIZONTAL,
  thumb: Block::FULL,
  begin_char: "←",
  end_char: "→",
}.freeze