Skip to content

Commit

Permalink
chore: revert "Remove irrelevant option comments"
Browse files Browse the repository at this point in the history
This reverts commit 439398b.
  • Loading branch information
aymanbagabas committed Feb 11, 2025
1 parent b0186ad commit ee7cf45
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions screen.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ type clearScreenMsg struct{}
// enter the alternate screen buffer (i.e. the full terminal window). The
// altscreen will be automatically exited when the program quits. To manually
// exit the altscreen while the program is running, use [ExitAltScreen].
//
// Because commands run asynchronously, this command should not be used in your
// model's Init function. To initialize your program with the altscreen enabled
// use the WithAltScreen ProgramOption instead.
func EnterAltScreen() Msg {
return enterAltScreenMsg{}
}
Expand Down Expand Up @@ -54,6 +58,10 @@ type exitAltScreenMsg struct{}
// EnableMouseCellMotion is a special command that enables mouse click,
// release, and wheel events. Mouse movement events are also captured if
// a mouse button is pressed (i.e., drag events).
//
// Because commands run asynchronously, this command should not be used in your
// model's Init function. Use the [WithMouseCellMotion] [ProgramOption]
// instead.
func EnableMouseCellMotion() Msg {
return enableMouseCellMotionMsg{}
}
Expand All @@ -69,6 +77,9 @@ type enableMouseCellMotionMsg struct{}
//
// Many modern terminals support this, but not all. If in doubt, use
// [EnableMouseCellMotion] instead.
//
// Because commands run asynchronously, this command should not be used in your
// model's Init function. Use the WithMouseAllMotion ProgramOption instead.
func EnableMouseAllMotion() Msg {
return enableMouseAllMotionMsg{}
}
Expand Down

0 comments on commit ee7cf45

Please sign in to comment.