static

Documentation

Overview

Package static provides a simple module that shows static content on the bar, with methods to set the content. In a pinch, this can be used to create buttons, or show additional information by setting the output from within a format function.

Index

• type Module
  • func New(initial bar.Output) *Module
  • func (m *Module) Clear()
  • func (m *Module) Set(out bar.Output)
  • func (m *Module) Stream(sink bar.Sink)

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

Module represents a module that displays static content on the bar.

func New

func New(initial bar.Output) *Module

New constructs a static module that displays the given output.

func (*Module) Clear

func (m *Module) Clear()

Clear sets an empty output.

func (*Module) Set

func (m *Module) Set(out bar.Output)

Set sets the output to display.

func (*Module) Stream

func (m *Module) Stream(sink bar.Sink)

Stream starts the module.