blessed-components - v1.20.0
    Preparing search index...

    Function renderMetricBars

    • Renders aligned labeled progress rows.

      This pure renderer composes renderProgressBar; it does not import Blessed. Import from blessed-components/metric-bars to keep the Blessed adapter outside the module graph.

      Output with a heading:

      [label] [value]
      
      [padded metric label] [track] [formatted value]
      

      Type Parameters

      • TMetric extends MetricBarItem

        Metric shape, including optional application metadata.

      Parameters

      Returns string

      Plain text without ANSI sequences or Blessed tags.

      RangeError Propagates invalid width, range, character, or metric value errors from renderProgressBar.

      import { renderMetricBars } from 'blessed-components/metric-bars';

      renderMetricBars({
      barWidth: 16,
      label: 'Overall',
      value: '85%',
      metrics: [
      { label: 'Quality', value: 78 },
      { label: 'Popularity', value: 99 },
      ],
      });
      renderMetricBars({
      barWidth: 10,
      metrics: [{ label: 'Latency', value: 25, unit: 'ms' }],
      formatValue: ({ metric, value }) => `${value}${metric.unit}`,
      });