summarybar

Documentation

Overview

Package summarybar provides renderers for summary bar.

Index

• func New(data []Datum, opts ...Opt) progress.Renderer
• type Datum
• type Opt
  • func WithEmptyRep(representation string) Opt
  • func WithWidth(width int) Opt

Functions

func New

func New(data []Datum, opts ...Opt) progress.Renderer

New returns a summaryBarComponent configured against opts.

Types

type Datum

type Datum struct {
	Representation string
	Value          int
}

Datum is the basic unit of summary bar. Each Datum is composed of a value and a representation. The value will be represented with the representation in the rendered summary bar.

type Opt

type Opt func(*summaryBarComponent)

Opt configures an option for summaryBarComponent.

func WithEmptyRep

func WithEmptyRep(representation string) Opt

WithEmptyRep is an opt that configures the empty representation for summaryBarComponent.

func WithWidth

func WithWidth(width int) Opt

WithWidth is an opt that configures the width for summaryBarComponent.