ui

Documentation

Overview

Package ui bundles the per-program rendering context — theme, key scheme, and glyph set. A Scope is immutable after construction; to change appearance, build a new Scope and swap the pointer. There is no process state to install: components read the Scope they are handed.

Index

• type Scope
  • func Default() *Scope
  • func (s *Scope) Bullet(msg string) string
  • func (s *Scope) Success(msg string) string

Types

type Scope

type Scope struct {
	Theme  theme.Theme
	Keys   keys.Scheme
	Glyphs glyph.Set
}

Scope is one program's rendering context.

func Default

func Default() *Scope

Default returns a Scope over the built-in defaults: the default theme and scheme, and the glyph set for the default mode (the one piece of process state left, by design — see glyph.SetMode).

func (*Scope) Bullet

func (s *Scope) Bullet(msg string) string

Bullet renders an accent-colored bullet followed by msg.

func (*Scope) Success

func (s *Scope) Success(msg string) string

Success renders a success-colored check followed by msg.