Overview

Show task completion progress.

Import

import { ProgressBar } from 'nikcli-tui';

Usage

new ProgressBar({ parent: screen, value: 60 });

Live Preview

Run Locally

npm run tsx:core-gallery

Props

  • value?: number — 0..100 initial value.
  • orientation?: ‘horizontal’ | ‘vertical’ — Bar orientation.
  • BaseProps: label, borderStyle, layout.

Methods

  • setValue(n) — Throttled renders for smooth updates.

Installation

npm i nikcli-tui

Import

import { ProgressBar } from 'nikcli-tui';

Quick Start

const p = new ProgressBar({ parent: screen, top: 1, left: 2, width: 40, value: 0 });
let v = 0; const t = setInterval(() => { v += 10; p.setValue(v); if (v >= 100) clearInterval(t); }, 150);

Production Examples

new ProgressBar({ parent: screen, top: 1, left: 44, height: 6, orientation: 'vertical', value: 60 });

Best Practices

  • Aggiorna con una cadenza di 100–200ms per evitare flicker.