username

Documentation

Index

• func Init(dbpool db.DB, user *db.User, sshUser string) func() (Model, tea.Cmd)
• func InitialCmd() tea.Cmd
• func View(m Model) string
• type Model
  • func NewModel(dbpool db.DB, user *db.User, sshUser string) Model
  • func Update(msg tea.Msg, m Model) (Model, tea.Cmd)
• type NameInvalidMsg
• type NameSetMsg
• type NameTakenMsg

Functions

func Init

func Init(dbpool db.DB, user *db.User, sshUser string) func() (Model, tea.Cmd)

Init is the Bubble Tea initialization function.

func InitialCmd

func InitialCmd() tea.Cmd

InitialCmd returns the initial command.

func View

func View(m Model) string

View renders current view from the model.

Types

type Model

type Model struct {
	Done bool // true when it's time to exit this view
	Quit bool // true when the user wants to quit the whole program
	// contains filtered or unexported fields
}

Model holds the state of the username UI.

func NewModel

func NewModel(dbpool db.DB, user *db.User, sshUser string) Model

NewModel returns a new username model in its initial state.

func Update

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

Update is the Bubble Tea update loop.

type NameInvalidMsg

type NameInvalidMsg struct{}

NameInvalidMsg is sent when the requested username has failed validation.

type NameSetMsg

type NameSetMsg string

NameSetMsg is sent when a new name has been set successfully. It contains the new name.

type NameTakenMsg

type NameTakenMsg struct{}

NameTakenMsg is sent when the requested username has already been taken.