screen

Documentation

Index

• Constants
• func ContentHeight(screen Screen, width int) int
• type GoToScreen
• type HomeScreen
  • func NewHomeScreen() HomeScreen
  • func (screen HomeScreen) Clear() Screen
  • func (screen HomeScreen) Keys() tools.Keybinds
  • func (screen HomeScreen) Lock() bool
  • func (screen HomeScreen) Messages() []tools.Message
  • func (screen HomeScreen) Notifications() []tools.Notification
  • func (screen HomeScreen) Title() string
  • func (screen HomeScreen) Update(raw tea.Msg) (Screen, tea.Cmd)
  • func (screen HomeScreen) View(width int) []string
• type Screen
• type ScreenTag
• type UserItem
  • func NewUserItem(id string) UserItem
  • func (item UserItem) Description() string
  • func (item UserItem) Id() string
  • func (item UserItem) Title() string
• type UserList
  • func NewUserList() UserList
  • func (list UserList) Items() []component.Item
  • func (list UserList) Size() int
• type UserScreen
  • func NewUserScreen() UserScreen
  • func (screen UserScreen) Clear() Screen
  • func (screen UserScreen) Keys() tools.Keybinds
  • func (screen UserScreen) Lock() bool
  • func (screen UserScreen) Messages() []tools.Message
  • func (screen UserScreen) Notifications() []tools.Notification
  • func (screen UserScreen) Title() string
  • func (screen UserScreen) Update(raw tea.Msg) (Screen, tea.Cmd)
  • func (screen UserScreen) View(width int) []string

Constants

const WELCOME_MESSAGE = "Welcome! You can see available actions on the bottom of the screen, press `?` to toggle the help message."

Functions

func ContentHeight

func ContentHeight(screen Screen, width int) int

Types

type GoToScreen

type GoToScreen struct {
	Tag ScreenTag
}

type HomeScreen

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

func NewHomeScreen

func NewHomeScreen() HomeScreen

func (HomeScreen) Clear

func (screen HomeScreen) Clear() Screen

func (HomeScreen) Keys

func (screen HomeScreen) Keys() tools.Keybinds

func (HomeScreen) Lock

func (screen HomeScreen) Lock() bool

func (HomeScreen) Messages

func (screen HomeScreen) Messages() []tools.Message

func (HomeScreen) Notifications

func (screen HomeScreen) Notifications() []tools.Notification

func (HomeScreen) Title

func (screen HomeScreen) Title() string

func (HomeScreen) Update

func (screen HomeScreen) Update(raw tea.Msg) (Screen, tea.Cmd)

func (HomeScreen) View

func (screen HomeScreen) View(width int) []string

type Screen

type Screen interface {
	Title() string
	Update(raw tea.Msg) (Screen, tea.Cmd)
	View(width int) []string
	Clear() Screen
	Messages() []tools.Message
	Notifications() []tools.Notification
	Keys() tools.Keybinds
	Lock() bool
}

type ScreenTag

type ScreenTag string

const (
	HOME_SCREEN ScreenTag = "home"
	USER_SCREEN ScreenTag = "user"
)

type UserItem

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

func NewUserItem

func NewUserItem(id string) UserItem

func (UserItem) Description

func (item UserItem) Description() string

func (UserItem) Id

func (item UserItem) Id() string

func (UserItem) Title

func (item UserItem) Title() string

type UserList

type UserList struct{}

func NewUserList

func NewUserList() UserList

func (UserList) Items

func (list UserList) Items() []component.Item

func (UserList) Size

func (list UserList) Size() int

type UserScreen

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

func NewUserScreen

func NewUserScreen() UserScreen

func (UserScreen) Clear

func (screen UserScreen) Clear() Screen

func (UserScreen) Keys

func (screen UserScreen) Keys() tools.Keybinds

func (UserScreen) Lock

func (screen UserScreen) Lock() bool

func (UserScreen) Messages

func (screen UserScreen) Messages() []tools.Message

func (UserScreen) Notifications

func (screen UserScreen) Notifications() []tools.Notification

func (UserScreen) Title

func (screen UserScreen) Title() string

func (UserScreen) Update

func (screen UserScreen) Update(raw tea.Msg) (Screen, tea.Cmd)

func (UserScreen) View

func (screen UserScreen) View(width int) []string