(v2) Generic model

environ.go

@@ -13,8 +13,8 @@ type environ []string
 // returned will be the empty string.
 // This function traverses the environment variables in reverse order, so that
 // the last value set for the key is the one returned.
-func (p *Program) getenv(key string) (v string) {
-	return p.environ.Getenv(key)
+func (p *Program[T]) getenv(key string) (v string) {
+	return environ(p.Env).Getenv(key)
 }
 
 // Getenv returns the value of the environment variable named by the key. If

examples/altscreen-toggle/main.go

@@ -19,11 +19,11 @@ type model struct {
 	suspending bool
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, nil
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.ResumeMsg:
 		m.suspending = false
@@ -79,7 +79,7 @@ func (m model) View() fmt.Stringer {
 }
 
 func main() {
-	if _, err := tea.NewProgram(model{}).Run(); err != nil {
+	if err := tea.NewProgram(model{}).Run(); err != nil {
 		fmt.Println("Error running program:", err)
 		os.Exit(1)
 	}

examples/autocomplete/main.go

@@ -16,7 +16,7 @@ import (
 
 func main() {
 	p := tea.NewProgram(initialModel())
-	if _, err := p.Run(); err != nil {
+	if err := p.Run(); err != nil {
 		log.Fatal(err)
 	}
 }
@@ -101,11 +101,11 @@ func initialModel() model {
 	return model{textInput: ti, help: h, keymap: km}
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, tea.Batch(getRepos, textinput.Blink)
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		switch msg.String() {

examples/capability/main.go

@@ -14,17 +14,15 @@ type model struct {
 	width int
 }
 
-var _ tea.Model = model{}
-
 // Init implements tea.Model.
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	m.input = textinput.New()
 	m.input.Placeholder = "Enter capability name to request"
 	return m, m.input.Focus()
 }
 
 // Update implements tea.Model.
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	var cmd tea.Cmd
 	switch msg := msg.(type) {
 	case tea.WindowSizeMsg:
@@ -59,7 +57,7 @@ func (m model) View() fmt.Stringer {
 }
 
 func main() {
-	if _, err := tea.NewProgram(model{}).Run(); err != nil {
+	if err := tea.NewProgram(model{}).Run(); err != nil {
 		log.Fatal(err)
 	}
 }

examples/cellbuffer/main.go

@@ -142,11 +142,15 @@ type model struct {
 	xVelocity, yVelocity float64
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
-	return m, animate()
+func (m model) Init() (model, tea.Cmd) {
+	return m, tea.Batch(
+		animate(),
+		tea.EnableMouseCellMotion,
+		tea.EnterAltScreen,
+	)
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		return m, tea.Quit
@@ -193,8 +197,8 @@ func main() {
 		spring: harmonica.NewSpring(harmonica.FPS(fps), frequency, damping),
 	}
 
-	p := tea.NewProgram(m, tea.WithAltScreen(), tea.WithMouseCellMotion())
-	if _, err := p.Run(); err != nil {
+	p := tea.NewProgram(m)
+	if err := p.Run(); err != nil {
 		fmt.Println("Uh oh:", err)
 		os.Exit(1)
 	}

examples/chat/main.go

@@ -19,7 +19,7 @@ const gap = "\n\n"
 
 func main() {
 	p := tea.NewProgram(initialModel())
-	if _, err := p.Run(); err != nil {
+	if err := p.Run(); err != nil {
 		fmt.Fprintf(os.Stderr, "Oof: %v\n", err)
 	}
 }
@@ -63,11 +63,11 @@ Type a message and press Enter to send.`)
 	}
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, textarea.Blink
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.WindowSizeMsg:
 		m.viewport.SetWidth(msg.Width)

examples/colorprofile/main.go

@@ -15,18 +15,16 @@ var myFancyColor color.Color
 
 type model struct{}
 
-var _ tea.Model = model{}
-
 // Init implements tea.Model.
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, tea.Batch(
 		tea.RequestCapability("RGB"),
 		tea.RequestCapability("Tc"),
 	)
 }
 
 // Update implements tea.Model.
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyMsg:
 		return m, tea.Quit
@@ -47,8 +45,9 @@ func (m model) View() fmt.Stringer {
 func main() {
 	myFancyColor, _ = colorful.Hex("#6b50ff")
 
-	p := tea.NewProgram(model{}, tea.WithColorProfile(colorprofile.TrueColor))
-	if _, err := p.Run(); err != nil {
+	p := tea.NewProgram(model{})
+	p.Profile = colorprofile.TrueColor
+	if err := p.Run(); err != nil {
 		log.Fatal(err)
 	}
 }

examples/composable-views/main.go

@@ -73,14 +73,14 @@ func newModel(timeout time.Duration) mainModel {
 	return m
 }
 
-func (m mainModel) Init() (tea.Model, tea.Cmd) {
+func (m mainModel) Init() (mainModel, tea.Cmd) {
 	// start the timer and spinner on program start
 	timer, cmd := m.timer.Init()
 	m.timer = timer
 	return m, tea.Batch(cmd, m.spinner.Tick)
 }
 
-func (m mainModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m mainModel) Update(msg tea.Msg) (mainModel, tea.Cmd) {
 	var cmd tea.Cmd
 	var cmds []tea.Cmd
 	switch msg := msg.(type) {
@@ -160,7 +160,7 @@ func (m *mainModel) resetSpinner() {
 func main() {
 	p := tea.NewProgram(newModel(defaultTime))
 
-	if _, err := p.Run(); err != nil {
+	if err := p.Run(); err != nil {
 		log.Fatal(err)
 	}
 }

examples/credit-card-form/main.go

@@ -14,7 +14,7 @@ import (
 func main() {
 	p := tea.NewProgram(initialModel())
 
-	if _, err := p.Run(); err != nil {
+	if err := p.Run(); err != nil {
 		log.Fatal(err)
 	}
 }
@@ -124,11 +124,11 @@ func initialModel() model {
 	}
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, textinput.Blink
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	var cmds []tea.Cmd = make([]tea.Cmd, len(m.inputs))
 
 	switch msg := msg.(type) {

examples/cursor-style/main.go

@@ -8,35 +8,35 @@ import (
 )
 
 type model struct {
-	style tea.CursorStyle
+	shape tea.CursorShape
 	blink bool
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	m.blink = true
 	return m, nil
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		switch msg.String() {
 		case "ctrl+q", "q":
 			return m, tea.Quit
 		case "h", "left":
-			if m.style == tea.CursorBlock && m.blink {
+			if m.shape == tea.CursorBlock && m.blink {
 				break
 			}
 			if m.blink {
-				m.style--
+				m.shape--
 			}
 			m.blink = !m.blink
 		case "l", "right":
-			if m.style == tea.CursorBar && !m.blink {
+			if m.shape == tea.CursorBar && !m.blink {
 				break
 			}
 			if !m.blink {
-				m.style++
+				m.shape++
 			}
 			m.blink = !m.blink
 		}
@@ -49,7 +49,7 @@ func (m model) View() fmt.Stringer {
 		"\n\n" +
 		"  <- This is the cursor (a " + m.describeCursor() + ")")
 	f.Cursor = tea.NewCursor(0, 2)
-	f.Cursor.Style = m.style
+	f.Cursor.Shape = m.shape
 	f.Cursor.Blink = m.blink
 	return f
 }
@@ -63,7 +63,7 @@ func (m model) describeCursor() string {
 		adj = "steady"
 	}
 
-	switch m.style {
+	switch m.shape {
 	case tea.CursorBlock:
 		noun = "block"
 	case tea.CursorUnderline:
@@ -77,7 +77,7 @@ func (m model) describeCursor() string {
 
 func main() {
 	p := tea.NewProgram(model{})
-	if _, err := p.Run(); err != nil {
+	if err := p.Run(); err != nil {
 		fmt.Fprintf(os.Stderr, "Error: %v", err)
 		os.Exit(1)
 	}

examples/debounce/main.go

@@ -26,11 +26,11 @@ type model struct {
 	tag int
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, nil
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		// Increment the tag on the model...
@@ -59,7 +59,7 @@ func (m model) View() fmt.Stringer {
 }
 
 func main() {
-	if _, err := tea.NewProgram(model{}).Run(); err != nil {
+	if err := tea.NewProgram(model{}).Run(); err != nil {
 		fmt.Println("uh oh:", err)
 		os.Exit(1)
 	}

examples/doom-fire/main.go

@@ -23,11 +23,14 @@ type model struct {
 	startTime   time.Time
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
-	return m, tick
+func (m model) Init() (model, tea.Cmd) {
+	return m, tea.Batch(
+		tick,
+		tea.EnterAltScreen,
+	)
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		if msg.String() == "q" || msg.String() == "ctrl+c" {
@@ -128,8 +131,8 @@ func initialModel() model {
 }
 
 func main() {
-	p := tea.NewProgram(initialModel(), tea.WithAltScreen())
-	if _, err := p.Run(); err != nil {
+	p := tea.NewProgram(initialModel())
+	if err := p.Run(); err != nil {
 		fmt.Printf("Error running program: %v", err)
 	}
 }

examples/exec/main.go

@@ -26,11 +26,11 @@ type model struct {
 	err             error
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	return m, nil
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		switch msg.String() {
@@ -64,7 +64,7 @@ func (m model) View() fmt.Stringer {
 
 func main() {
 	m := model{}
-	if _, err := tea.NewProgram(m).Run(); err != nil {
+	if err := tea.NewProgram(m).Run(); err != nil {
 		fmt.Println("Error running program:", err)
 		os.Exit(1)
 	}

examples/file-picker/main.go

@@ -26,13 +26,16 @@ func clearErrorAfter(t time.Duration) tea.Cmd {
 	})
 }
 
-func (m model) Init() (tea.Model, tea.Cmd) {
+func (m model) Init() (model, tea.Cmd) {
 	fp, cmd := m.filepicker.Init()
 	m.filepicker = fp
-	return m, cmd
+	return m, tea.Batch(
+		tea.EnterAltScreen,
+		cmd,
+	)
 }
 
-func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m model) Update(msg tea.Msg) (model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyPressMsg:
 		switch msg.String() {
@@ -90,7 +93,10 @@ func main() {
 	m := model{
 		filepicker: fp,
 	}
-	tm, _ := tea.NewProgram(&m, tea.WithAltScreen()).Run()
-	mm := tm.(model)
-	fmt.Println("\n  You selected: " + m.filepicker.Styles.Selected.Render(mm.selectedFile) + "\n")
+	tm := tea.NewProgram(&m)
+	if err := tm.Run(); err != nil {
+		fmt.Println("Error running program:", err)
+		os.Exit(1)
+	}
+	fmt.Println("\n  You selected: " + m.filepicker.Styles.Selected.Render(tm.Model.selectedFile) + "\n")
 }