Skip to content

atomicgo/cursor

main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

AtomicGo | cursor

Downloads Latest Release Tests Coverage Unit test count License: MIT Go report


Get The Module | Documentation | Contributing | Code of Conduct


AtomicGo


-----------------------------------------------------------------------------------------------------

go get atomicgo.dev/cursor


-----------------------------------------------------------------------------------------------------

cursor

import "atomicgo.dev/cursor"

Package cursor contains cross-platform methods to move the terminal cursor in different directions. This package can be used to create interactive CLI tools and games, live charts, algorithm visualizations and other updatable output of any kind.

Works niceley with https://github.com/atomicgo/keyboard

Special thanks to github.com/k0kubun/go-ansi which this project is based on.

Index

func Bottom

func Bottom()

Bottom moves the cursor to the bottom of the terminal. This is done by calculating how many lines were moved by Up and Down.

func ClearLine

func ClearLine()

ClearLine clears the current line and moves the cursor to it's start position.

func ClearLinesDown

func ClearLinesDown(n int)

ClearLinesDown clears n lines downwards from the current position and moves the cursor.

func ClearLinesUp

func ClearLinesUp(n int)

ClearLinesUp clears n lines upwards from the current position and moves the cursor.

func Down

func Down(n int)

Down moves the cursor n lines down relative to the current position.

func DownAndClear

func DownAndClear(n int)

DownAndClear moves the cursor down by n lines, then clears the line.

func Hide

func Hide()

Hide the cursor. Don't forget to show the cursor at least at the end of your application with Show. Otherwise the user might have a terminal with a permanently hidden cursor, until they reopen the terminal.

func HorizontalAbsolute

func HorizontalAbsolute(n int)

HorizontalAbsolute moves the cursor to n horizontally. The position n is absolute to the start of the line.

func Left

func Left(n int)

Left moves the cursor n characters to the left relative to the current position.

func Move

func Move(x, y int)

Move moves the cursor relative by x and y.

func Right

func Right(n int)

Right moves the cursor n characters to the right relative to the current position.

func SetTarget

func SetTarget(w Writer)

SetTarget allows for any arbitrary io.Writer to be used for cursor movement (will not work on Windows).

func Show

func Show()

Show the cursor if it was hidden previously. Don't forget to show the cursor at least at the end of your application. Otherwise the user might have a terminal with a permanently hidden cursor, until they reopen the terminal.

func StartOfLine

func StartOfLine()

StartOfLine moves the cursor to the start of the current line.

func StartOfLineDown

func StartOfLineDown(n int)

StartOfLineDown moves the cursor down by n lines, then moves to cursor to the start of the line.

func StartOfLineUp

func StartOfLineUp(n int)

StartOfLineUp moves the cursor up by n lines, then moves to cursor to the start of the line.

func TestCustomIOWriter

func TestCustomIOWriter(t *testing.T)

func Up

func Up(n int)

Up moves the cursor n lines up relative to the current position.

func UpAndClear

func UpAndClear(n int)

UpAndClear moves the cursor up by n lines, then clears the line.

type Area

Area displays content which can be updated on the fly. You can use this to create live output, charts, dropdowns, etc.

type Area struct {
    // contains filtered or unexported fields
}

func NewArea

func NewArea() Area

NewArea returns a new Area.

func (*Area) Clear

func (area *Area) Clear()

Clear clears the content of the Area.

func (*Area) Update

func (area *Area) Update(content string)

Update overwrites the content of the Area.

type Writer

Writer is an expanded io.Writer interface with a file descriptor.

type Writer interface {
    io.Writer
    Fd() uintptr
}

Generated by gomarkdoc


AtomicGo.dev  ·  with ❤️ by @MarvinJWendt | MarvinJWendt.com

About

🖱️ Go module to move the terminal cursor in any direction on every operating system.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages