Update pager example per viewport API update

This commit is contained in:
Christian Rocha 2021-09-02 13:25:37 -04:00
parent bdb04767ff
commit 1ca2b1cd40
1 changed files with 39 additions and 60 deletions

View File

@ -5,62 +5,35 @@ package main
import ( import (
"fmt" "fmt"
"io/ioutil"
"os" "os"
"strings" "strings"
"github.com/charmbracelet/bubbles/viewport" "github.com/charmbracelet/bubbles/viewport"
tea "github.com/charmbracelet/bubbletea" tea "github.com/charmbracelet/bubbletea"
"github.com/charmbracelet/lipgloss"
"github.com/mattn/go-runewidth" "github.com/mattn/go-runewidth"
) )
const ( // You generally won't need this unless you're processing stuff with
// You generally won't need this unless you're processing stuff with some // complicated ANSI escape sequences. Turn it on if you notice flickering.
// pretty complicated ANSI escape sequences. Turn it on if you notice
// flickering.
// //
// Also note that high performance rendering only works for programs that // Also keep in mind that high performance rendering only works for programs
// use the full size of the terminal. We're enabling that below with // that use the full size of the terminal. We're enabling that below with
// tea.EnterAltScreen(). // tea.EnterAltScreen().
useHighPerformanceRenderer = false const useHighPerformanceRenderer = false
headerHeight = 3
footerHeight = 3
)
func main() { func main() {
// Load some text for our viewport
// Load some text to render content, err := os.ReadFile("artichoke.md")
content, err := ioutil.ReadFile("artichoke.md")
if err != nil { if err != nil {
fmt.Println("could not load file:", err) fmt.Println("could not load file:", err)
os.Exit(1) os.Exit(1)
} }
// Set PAGER_LOG to a path to log to a file. For example:
//
// export PAGER_LOG=debug.log
//
// This becomes handy when debugging stuff since you can't debug to stdout
// because the UI is occupying it!
path := os.Getenv("PAGER_LOG")
if path != "" {
f, err := tea.LogToFile(path, "pager")
if err != nil {
fmt.Printf("Could not open file %s: %v", path, err)
os.Exit(1)
}
defer f.Close()
}
p := tea.NewProgram( p := tea.NewProgram(
model{content: string(content)}, model{content: string(content)},
tea.WithAltScreen(), // use the full size of the terminal in its "alternate screen buffer"
// Use the full size of the terminal in its "alternate screen buffer" tea.WithMouseCellMotion(), // turn on mouse support so we can track the mouse wheel
tea.WithAltScreen(),
// Also turn on mouse support so we can track the mouse wheel
tea.WithMouseCellMotion(),
) )
if err := p.Start(); err != nil { if err := p.Start(); err != nil {
@ -92,15 +65,18 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
} }
case tea.WindowSizeMsg: case tea.WindowSizeMsg:
verticalMargins := headerHeight + footerHeight headerHeight := lipgloss.Height(m.headerView())
footerHeight := lipgloss.Height(m.footerView())
verticalMarginHeight := headerHeight + footerHeight
if !m.ready { if !m.ready {
// Since this program is using the full size of the viewport we need // Since this program is using the full size of the viewport we
// to wait until we've received the window dimensions before we // need to wait until we've received the window dimensions before
// can initialize the viewport. The initial dimensions come in // we can initialize the viewport. The initial dimensions come in
// quickly, though asynchronously, which is why we wait for them // quickly, though asynchronously, which is why we wait for them
// here. // here.
m.viewport = viewport.Model{Width: msg.Width, Height: msg.Height - verticalMargins} m.viewport = viewport.NewModel(msg.Width, msg.Height-verticalMarginHeight)
m.viewport.YPosition = headerHeight
m.viewport.HighPerformanceRendering = useHighPerformanceRenderer m.viewport.HighPerformanceRendering = useHighPerformanceRenderer
m.viewport.SetContent(m.content) m.viewport.SetContent(m.content)
m.ready = true m.ready = true
@ -112,7 +88,7 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
m.viewport.YPosition = headerHeight + 1 m.viewport.YPosition = headerHeight + 1
} else { } else {
m.viewport.Width = msg.Width m.viewport.Width = msg.Width
m.viewport.Height = msg.Height - verticalMargins m.viewport.Height = msg.Height - verticalMarginHeight
} }
if useHighPerformanceRenderer { if useHighPerformanceRenderer {
@ -124,16 +100,9 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
} }
} }
// Because we're using the viewport's default update function (with pager- // Handle keyboard and mouse events in the viewport
// style navigation) it's important that the viewport's update function:
//
// * Receives messages from the Bubble Tea runtime
// * Returns commands to the Bubble Tea runtime
//
m.viewport, cmd = m.viewport.Update(msg) m.viewport, cmd = m.viewport.Update(msg)
if useHighPerformanceRenderer {
cmds = append(cmds, cmd) cmds = append(cmds, cmd)
}
return m, tea.Batch(cmds...) return m, tea.Batch(cmds...)
} }
@ -142,21 +111,31 @@ func (m model) View() string {
if !m.ready { if !m.ready {
return "\n Initializing..." return "\n Initializing..."
} }
return fmt.Sprintf("%s\n%s\n%s", m.headerView(), m.viewport.View(), m.footerView())
}
func (m model) headerView() string {
headerTop := "╭───────────╮" headerTop := "╭───────────╮"
headerMid := "│ Mr. Pager ├" headerMid := "│ Mr. Pager ├"
headerBot := "╰───────────╯" headerBot := "╰───────────╯"
headerMid += strings.Repeat("─", m.viewport.Width-runewidth.StringWidth(headerMid)) headerMid += strings.Repeat("─", max(0, m.viewport.Width-runewidth.StringWidth(headerMid)))
header := fmt.Sprintf("%s\n%s\n%s", headerTop, headerMid, headerBot) return fmt.Sprintf("%s\n%s\n%s", headerTop, headerMid, headerBot)
}
func (m model) footerView() string {
footerTop := "╭──────╮" footerTop := "╭──────╮"
footerMid := fmt.Sprintf("┤ %3.f%% │", m.viewport.ScrollPercent()*100) footerMid := fmt.Sprintf("┤ %3.f%% │", m.viewport.ScrollPercent()*100)
footerBot := "╰──────╯" footerBot := "╰──────╯"
gapSize := m.viewport.Width - runewidth.StringWidth(footerMid) gapSize := max(0, m.viewport.Width-runewidth.StringWidth(footerMid))
footerTop = strings.Repeat(" ", gapSize) + footerTop footerTop = strings.Repeat(" ", gapSize) + footerTop
footerMid = strings.Repeat("─", gapSize) + footerMid footerMid = strings.Repeat("─", gapSize) + footerMid
footerBot = strings.Repeat(" ", gapSize) + footerBot footerBot = strings.Repeat(" ", gapSize) + footerBot
footer := fmt.Sprintf("%s\n%s\n%s", footerTop, footerMid, footerBot) return fmt.Sprintf("%s\n%s\n%s", footerTop, footerMid, footerBot)
}
return fmt.Sprintf("%s\n%s\n%s", header, m.viewport.View(), footer)
func max(a, b int) int {
if a > b {
return a
}
return b
} }