checkbox

Documentation

Index

• type Widget
  • func New(label string) *Widget
  • func (w *Widget) GetMinSize() orvyn.Size
  • func (w *Widget) GetPreferredSize() orvyn.Size
  • func (w *Widget) IsChecked() bool
  • func (w *Widget) Render() string
  • func (w *Widget) Resize(size orvyn.Size)
  • func (w *Widget) SetChecked(checked bool)
  • func (w *Widget) SetLabel(label string)
  • func (w *Widget) Update(msg tea.Msg) tea.Cmd

Types

type Widget

type Widget struct {
	orvyn.BaseWidget
	orvyn.BaseFocusable

	CheckKeybind key.Binding
	// contains filtered or unexported fields
}

Widget is a checkbox widget holding 2 state : Checked and Unchecked.

func New

func New(label string) *Widget

New creates and returns a new checkbox *Widget.

func (*Widget) GetMinSize

func (w *Widget) GetMinSize() orvyn.Size

func (*Widget) GetPreferredSize

func (w *Widget) GetPreferredSize() orvyn.Size

func (*Widget) IsChecked

func (w *Widget) IsChecked() bool

IsChecked returns the current state of the checkbox.

func (*Widget) Render

func (w *Widget) Render() string

func (*Widget) Resize

func (w *Widget) Resize(size orvyn.Size)

func (*Widget) SetChecked

func (w *Widget) SetChecked(checked bool)

SetChecked changes the current state of the checkbox.

func (*Widget) SetLabel

func (w *Widget) SetLabel(label string)

SetLabel changes the label associated to the checkbox.

func (*Widget) Update

func (w *Widget) Update(msg tea.Msg) tea.Cmd