feat: add tea.ShowCursor, complementing tea.HideCursor

charmbracelet · Oct 4, 2022 · eab831d · eab831d
1 parent e4ca150
commit eab831d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/screen.go b/screen.go
@@ -92,6 +92,16 @@ func HideCursor() Msg {
 // this message with HideCursor.
 type hideCursorMsg struct{}
 
+// ShowCursor is a special command for manually instructing Bubble Tea to show
+// the cursor.
+func ShowCursor() Msg {
+	return showCursorMsg{}
+}
+
+// showCursorMsg is an internal command used to show the cursor. You can send
+// this message with ShowCursor.
+type showCursorMsg struct{}
+
 // EnterAltScreen enters the alternate screen buffer, which consumes the entire
 // terminal window. ExitAltScreen will return the terminal to its former state.
 //

diff --git a/tea.go b/tea.go
@@ -422,6 +422,9 @@ func (p *Program) StartReturningModel() (Model, error) {
 				p.renderer.disableMouseCellMotion()
 				p.renderer.disableMouseAllMotion()
 
+			case showCursorMsg:
+				p.renderer.showCursor()
+
 			case hideCursorMsg:
 				p.renderer.hideCursor()