taigrr/bubbletea
1
0
Fork 0
mirror of https://github.com/taigrr/bubbletea.git synced 2026-04-02 02:59:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

Improve GoDocs

Browse Source
This commit is contained in:
Christian Rocha
2020-07-29 20:49:20 -04:00
parent a784aa32ca
commit c0f67a2927
4 changed files with 64 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
renderer.go
View File

@@ -326,9 +326,9 @@ type syncScrollAreaMsg struct {
bottomBoundary int
}
// SyncScrollArea performs a paint of the entire scroll area. This is required
// to initialize the scrollable region and should also be called on resize
// (WindowSizeMsg).
// SyncScrollArea performs a paint of the entire region designated to be the
// scrollable area. This is required to initialize the scrollable region and
// should also be called on resize (WindowSizeMsg).
//
// For high-performance, scroll-based rendering only.
func SyncScrollArea(lines []string, topBoundary int, bottomBoundary int) Cmd {
@@ -357,8 +357,9 @@ type scrollUpMsg struct {
bottomBoundary int
}
// ScrollUp adds lines to the top of the scrollable region, pushing lines below
// down. Lines that are pushed out the scrollable region disappear from view.
// ScrollUp adds lines to the top of the scrollable region, pushing existing
// lines below down. Lines that are pushed out the scrollable region disappear
// from view.
//
// For high-performance, scroll-based rendering only.
func ScrollUp(newLines []string, topBoundary, bottomBoundary int) Cmd {
@@ -377,9 +378,9 @@ type scrollDownMsg struct {
bottomBoundary int
}
// ScrollDown adds lines to the bottom of the scrollable region, pushing lines
// above up. Lines that are pushed out of the scrollable region disappear from
// view.
// ScrollDown adds lines to the bottom of the scrollable region, pushing
// existing lines above up. Lines that are pushed out of the scrollable region
// disappear from view.
//
// For high-performance, scroll-based rendering only.
func ScrollDown(newLines []string, topBoundary, bottomBoundary int) Cmd {