widgets

Documentation

Overview

Package widgets contains a YaGoStatus widgets.

Index

• func NewBlankWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)
• func NewClockWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)
• func NewExecWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)
• func NewHTTPWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)
• func NewStaticWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)
• func NewWrapperWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)
• type BlankWidget
  • func (w *BlankWidget) Continue() error
  • func (w *BlankWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error
  • func (w *BlankWidget) Run(c chan<- []ygs.I3BarBlock) error
  • func (w *BlankWidget) Shutdown() error
  • func (w *BlankWidget) Stop() error
• type BlankWidgetParams
• type ClockWidget
  • func (w *ClockWidget) Run(c chan<- []ygs.I3BarBlock) error
• type ClockWidgetParams
• type ExecWidget
  • func (w *ExecWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error
  • func (w *ExecWidget) Run(c chan<- []ygs.I3BarBlock) error
• type ExecWidgetParams
• type HTTPWidget
  • func (w *HTTPWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error
  • func (w *HTTPWidget) Run(c chan<- []ygs.I3BarBlock) error
  • func (w *HTTPWidget) Shutdown() error
• type HTTPWidgetParams
• type StaticWidget
  • func (w *StaticWidget) Run(c chan<- []ygs.I3BarBlock) error
• type StaticWidgetParams
• type WrapperWidget
  • func (w *WrapperWidget) Continue() error
  • func (w *WrapperWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error
  • func (w *WrapperWidget) Run(c chan<- []ygs.I3BarBlock) error
  • func (w *WrapperWidget) Shutdown() error
  • func (w *WrapperWidget) Stop() error
• type WrapperWidgetParams

Functions

func NewBlankWidget

func NewBlankWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)

NewBlankWidget returns a new BlankWidget.

func NewClockWidget

func NewClockWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)

NewClockWidget returns a new ClockWidget.

func NewExecWidget

func NewExecWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)

NewExecWidget returns a new ExecWidget.

func NewHTTPWidget

func NewHTTPWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)

NewHTTPWidget returns a new HTTPWidget.

func NewStaticWidget

func NewStaticWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)

NewStaticWidget returns a new StaticWidget.

func NewWrapperWidget

func NewWrapperWidget(params interface{}, wlogger logger.Logger) (ygs.Widget, error)

NewWrapperWidget returns a new WrapperWidget.

Types

type BlankWidget

type BlankWidget struct{}

BlankWidget is a widgets template.

func (*BlankWidget) Continue

func (w *BlankWidget) Continue() error

Continue continues the widdget.

func (*BlankWidget) Event

func (w *BlankWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error

Event processes the widget events.

func (*BlankWidget) Run

func (w *BlankWidget) Run(c chan<- []ygs.I3BarBlock) error

Run starts the main loop.

func (*BlankWidget) Shutdown

func (w *BlankWidget) Shutdown() error

Shutdown shutdowns the widget.

func (*BlankWidget) Stop

func (w *BlankWidget) Stop() error

Stop stops the widdget.

type BlankWidgetParams

type BlankWidgetParams struct{}

BlankWidgetParams are widget parameters.

type ClockWidget

type ClockWidget struct {
	BlankWidget
	// contains filtered or unexported fields
}

ClockWidget implements a clock.

func (*ClockWidget) Run

func (w *ClockWidget) Run(c chan<- []ygs.I3BarBlock) error

Run starts the main loop.

type ClockWidgetParams

type ClockWidgetParams struct {
	Interval uint
	Format   string
}

ClockWidgetParams are widget parameters.

type ExecWidget

type ExecWidget struct {
	BlankWidget
	// contains filtered or unexported fields
}

ExecWidget implements the exec widget.

func (*ExecWidget) Event

func (w *ExecWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error

Event processes the widget events.

func (*ExecWidget) Run

func (w *ExecWidget) Run(c chan<- []ygs.I3BarBlock) error

Run starts the main loop.

type ExecWidgetParams

type ExecWidgetParams struct {
	Command      string
	Interval     int
	Retry        *int
	Silent       bool
	EventsUpdate bool `yaml:"events_update"`
	Signal       *int
	OutputFormat executor.OutputFormat `yaml:"output_format"`
	WorkDir      string
}

ExecWidgetParams are widget parameters.

type HTTPWidget

type HTTPWidget struct {
	BlankWidget
	// contains filtered or unexported fields
}

HTTPWidget implements the http server widget.

func (*HTTPWidget) Event

func (w *HTTPWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error

Event processes the widget events.

func (*HTTPWidget) Run

func (w *HTTPWidget) Run(c chan<- []ygs.I3BarBlock) error

Run starts the main loop.

func (*HTTPWidget) Shutdown

func (w *HTTPWidget) Shutdown() error

type HTTPWidgetParams

type HTTPWidgetParams struct {
	Network string
	Listen  string
	Path    string
}

HTTPWidgetParams are widget parameters.

type StaticWidget

type StaticWidget struct {
	BlankWidget
	// contains filtered or unexported fields
}

StaticWidget implements a static widget.

func (*StaticWidget) Run

func (w *StaticWidget) Run(c chan<- []ygs.I3BarBlock) error

Run returns configured blocks.

type StaticWidgetParams

type StaticWidgetParams struct {
	Blocks string
}

StaticWidgetParams are widget parameters.

type WrapperWidget

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

WrapperWidget implements the wrapper of other status commands.

func (*WrapperWidget) Continue

func (w *WrapperWidget) Continue() error

Continue continues the widdget.

func (*WrapperWidget) Event

func (w *WrapperWidget) Event(event ygs.I3BarClickEvent, blocks []ygs.I3BarBlock) error

Event processes the widget events.

func (*WrapperWidget) Run

func (w *WrapperWidget) Run(c chan<- []ygs.I3BarBlock) error

Run starts the main loop.

func (*WrapperWidget) Shutdown

func (w *WrapperWidget) Shutdown() error

Shutdown shutdowns the widget.

func (*WrapperWidget) Stop

func (w *WrapperWidget) Stop() error

Stop stops the widdget.

type WrapperWidgetParams

type WrapperWidgetParams struct {
	Command string
	WorkDir string
}

WrapperWidgetParams are widget parameters.