README
¶
go-cursor
Provides ANSI escape sequences (strings) for manipulating cursor on terminals.
Usage
Here is equivalent of clear program (cls command on Windows) written in Go
using go-cursor:
package main
import (
"fmt"
"github.com/ahmetalpbalkan/go-cursor"
)
func main() {
fmt.Print(cursor.ClearEntireScreen())
fmt.Print(cursor.MoveTo(0, 0))
}
Documentation
¶
Overview ¶
Package cursor provides ANSI Escape sequences introduced in VT-100 terminals for cursor and screen manipulation operations.
Index ¶
- Variables
- func ClearEntireLine() string
- func ClearEntireScreen() string
- func ClearLineLeft() string
- func ClearLineRight() string
- func ClearScreenDown() string
- func ClearScreenUp() string
- func Hide() string
- func MoveDown(n int) string
- func MoveLeft(n int) string
- func MoveNextLine() string
- func MoveRight(n int) string
- func MoveTo(line, col int) string
- func MoveUp(n int) string
- func MoveUpperLeft(n int) string
- func RestoreAttributes() string
- func SaveAttributes() string
- func Show() string
Constants ¶
This section is empty.
Variables ¶
var Esc = "\x1b"
Functions ¶
func ClearEntireLine ¶
func ClearEntireLine() string
ClearEntireLine returns ANSI escape sequence to clear current line.
func ClearEntireScreen ¶
func ClearEntireScreen() string
ClearEntireScreen returns ANSI escape sequence to clear the screen.
func ClearLineLeft ¶
func ClearLineLeft() string
ClearLineLeft returns ANSI escape sequence to clear line from left of the cursor.
func ClearLineRight ¶
func ClearLineRight() string
ClearLineRight returns ANSI escape sequence to clear line from right of the cursor.
func ClearScreenDown ¶
func ClearScreenDown() string
ClearScreenDown returns ANSI escape sequence to clear screen below. the cursor.
func ClearScreenUp ¶
func ClearScreenUp() string
ClearScreenUp returns ANSI escape sequence to clear screen above. the cursor.
func MoveNextLine ¶
func MoveNextLine() string
MoveNextLine returns ANSI escape sequence to move cursor to next line.
func MoveUpperLeft ¶
MoveUpperLeft returns ANSI escape sequence to move cursor to upper left corner of screen.
func RestoreAttributes ¶
func RestoreAttributes() string
RestoreAttributes returns ANSI escape sequence to restore saved position and attributes of the cursor.
func SaveAttributes ¶
func SaveAttributes() string
SaveAttributes returns ANSI escape sequence to save current position and attributes of the cursor.
Types ¶
This section is empty.
Source Files