ui

Documentation

Index

• func Select(verbose, quiet bool) (uis []clio.UI)
• type NoUI
  • func None(quiet bool) *NoUI
  • func (n *NoUI) Handle(e partybus.Event) error
  • func (n *NoUI) Setup(subscription partybus.Unsubscribable) error
  • func (n NoUI) Teardown(_ bool) error
• type UI
  • func New(_, quiet bool, hs ...bubbly.EventHandler) *UI
  • func (m *UI) Handle(e partybus.Event) error
  • func (m UI) Init() tea.Cmd
  • func (m UI) RespondsTo() []partybus.EventType
  • func (m *UI) Setup(subscription partybus.Unsubscribable) error
  • func (m *UI) Teardown(force bool) error
  • func (m *UI) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m UI) View() string

Functions

func Select

func Select(verbose, quiet bool) (uis []clio.UI)

Select is responsible for determining the specific UI function given select user option, the current platform config values, and environment status (such as a TTY being present). The first UI in the returned slice of UIs is intended to be used and the UIs that follow are meant to be attempted only in a fallback posture when there are environmental problems (e.g. cannot write to the terminal). A writer is provided to capture the output of the final SBOM report.

Types

type NoUI

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

func None

func None(quiet bool) *NoUI

func (*NoUI) Handle

func (n *NoUI) Handle(e partybus.Event) error

func (*NoUI) Setup

func (n *NoUI) Setup(subscription partybus.Unsubscribable) error

func (NoUI) Teardown

func (n NoUI) Teardown(_ bool) error

type UI

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

func New

func New(_, quiet bool, hs ...bubbly.EventHandler) *UI

func (*UI) Handle

func (m *UI) Handle(e partybus.Event) error

func (UI) Init

func (m UI) Init() tea.Cmd

func (UI) RespondsTo

func (m UI) RespondsTo() []partybus.EventType

func (*UI) Setup

func (m *UI) Setup(subscription partybus.Unsubscribable) error

func (*UI) Teardown

func (m *UI) Teardown(force bool) error

func (*UI) Update

func (m *UI) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (UI) View

func (m UI) View() string