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

    Function renderBadge

    • Renders compact semantic status text.

      This function is framework-independent. Import from blessed-components/badge to keep Blessed outside the module graph.

      Bracketed output:

      [marker text]
      

      Plain output:

      marker text
      

      Parameters

      Returns string

      Plain text without ANSI sequences or Blessed tags.

      RangeError Thrown when text, any marker, or either delimiter is empty.

      import { renderBadge } from 'blessed-components/badge';

      renderBadge({
      text: 'Passed',
      tone: 'success',
      });
      // "[✓ Passed]"
      renderBadge({
      delimiters: { open: '<', close: '>' },
      markers: {
      neutral: '-',
      info: 'i',
      success: '+',
      warning: '!',
      danger: 'x',
      },
      text: 'Passed',
      tone: 'success',
      });
      // "<+ Passed>"