ui

Documentation

Index

• func WithUI(ctx context.Context, u *UI) context.Context
• type ColorMode
• type Options
• type UI
  • func FromContext(ctx context.Context) *UI
  • func New(opts Options) *UI
  • func (u *UI) Err() io.Writer
  • func (u *UI) Out() io.Writer
  • func (u *UI) Profile() termenv.Profile

Functions

func WithUI

func WithUI(ctx context.Context, u *UI) context.Context

WithUI adds the UI to the context

Types

type ColorMode

type ColorMode int

ColorMode defines how colors should be handled

const (
	ColorAuto ColorMode = iota
	ColorAlways
	ColorNever
)

type Options

type Options struct {
	Out       io.Writer
	Err       io.Writer
	ColorMode ColorMode
}

Options configures the UI

type UI

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

UI handles output and color support

func FromContext

func FromContext(ctx context.Context) *UI

FromContext retrieves the UI from the context

func New

func New(opts Options) *UI

New creates a new UI with the given options

func (*UI) Err

func (u *UI) Err() io.Writer

Err returns the stderr writer

func (*UI) Out

func (u *UI) Out() io.Writer

Out returns the stdout writer

func (*UI) Profile

func (u *UI) Profile() termenv.Profile

Profile returns the termenv profile for color support