tui

package

v0.4.0 Latest Latest Go to latest Published: Nov 12, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/slashformotion/radioboat

Documentation ¶

Index ¶

Constants
Variables
func CmdSaveTrack(trackFilePath, track string) tea.Cmd
func CmdTickerMessageBox() tea.Msg
func HeaderToString(currentStation string, trackName string, volume int, muted bool) string
func InitialModel(p *player.MpvPlayer, stations []*urls.Station, volume int, ...) model
type KeyMap
- func (k KeyMap) FullHelp() [][]key.Binding
- func (k KeyMap) ShortHelp() []key.Binding
type Message
- func NewMessage(msg string) *Message
- func NewMessageFromErr(err error) *Message
type MessageBox
- func (mb *MessageBox) Update(tmsg tea.Msg) tea.Cmd
- func (mb *MessageBox) View() string
type SaveTrackMsg
type TickMessageBox

Constants ¶

View Source

const BASE_DELAY = 5 * time.Second

Message livespan

Variables ¶

View Source

var DefaultKeyMap = KeyMap{
	Up: key.NewBinding(
		key.WithKeys("k", "up"),
		key.WithHelp("↑/k", "move up"),
	),
	Down: key.NewBinding(
		key.WithKeys("j", "down"),
		key.WithHelp("↓/j", "move down"),
	),
	Right: key.NewBinding(
		key.WithKeys("l", "right"),
		key.WithHelp("→/l", "move right"),
	),
	Left: key.NewBinding(
		key.WithKeys("h", "left"),
		key.WithHelp("←/j", "move left"),
	),
	ToggleMute: key.NewBinding(
		key.WithKeys("m"),
		key.WithHelp("m", "mute/unmute"),
	),
	Play: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("Enter", "Play station"),
	),
	VolumeUp: key.NewBinding(
		key.WithKeys("*", "-"),
		key.WithHelp("*", "Increase volume"),
	),
	VolumeDown: key.NewBinding(
		key.WithKeys("/", "-"),
		key.WithHelp("/", "Decrease volume"),
	),
	Quit: key.NewBinding(
		key.WithKeys("ctrl+c", "esc", "q"),
		key.WithHelp("Ctrl+C/Escape/q", "Quit"),
	),
	SaveTrack: key.NewBinding(
		key.WithKeys("ctrl+s"),
		key.WithHelp("Ctrl+s", "Save current track name to track file"),
	),
	Help: key.NewBinding(
		key.WithKeys("h"),
		key.WithHelp("h", "Show All keybindings"),
	),
}

Functions ¶

func CmdSaveTrack ¶ added in v0.2.0

func CmdSaveTrack(trackFilePath, track string) tea.Cmd

func CmdTickerMessageBox ¶ added in v0.2.2

func CmdTickerMessageBox() tea.Msg

wait 1 sec and then send a Tick

func HeaderToString ¶ added in v0.2.0

func HeaderToString(currentStation string, trackName string, volume int, muted bool) string

func InitialModel ¶

func InitialModel(p *player.MpvPlayer, stations []*urls.Station, volume int, trackFilePath string, chanEvent chan mpv.Event) model

Types ¶

type KeyMap ¶

type KeyMap struct {
	Up         key.Binding
	Down       key.Binding
	Right      key.Binding
	Left       key.Binding
	ToggleMute key.Binding
	Play       key.Binding
	Quit       key.Binding
	VolumeUp   key.Binding
	VolumeDown key.Binding
	SaveTrack  key.Binding
	Help       key.Binding
}

func (KeyMap) FullHelp ¶

func (k KeyMap) FullHelp() [][]key.Binding

FullHelp returns keybindings for the expanded help view. It's part of the key.Map interface.

func (KeyMap) ShortHelp ¶

func (k KeyMap) ShortHelp() []key.Binding

ShortHelp returns keybindings to be shown in the mini help view. It's part of the key.Map interface.

type Message ¶ added in v0.2.2

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

func NewMessage ¶ added in v0.2.2

func NewMessage(msg string) *Message

func NewMessageFromErr ¶ added in v0.2.2

func NewMessageFromErr(err error) *Message

type MessageBox ¶ added in v0.2.2

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

func (*MessageBox) Update ¶ added in v0.2.2

func (mb *MessageBox) Update(tmsg tea.Msg) tea.Cmd

Update the Message box

func (*MessageBox) View ¶ added in v0.2.2

func (mb *MessageBox) View() string

type SaveTrackMsg ¶ added in v0.2.0

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

tea.Msg send by CmdSaveTrack

type TickMessageBox ¶ added in v0.2.2

type TickMessageBox struct{}

tea.Msg send by CmdTickerTrackname

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL