Skip to content
generated from atomicgo/template

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

License

Notifications You must be signed in to change notification settings

atomicgo/cursor

Repository files navigation

AtomicGo | cursor

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


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 Clear

func Clear()

Clear clears the current position and moves the cursor to the left.

func ClearLine()

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

func ClearLinesDown(n int)

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

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(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(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(w Writer)

SetTarget sets to output target of the default curser to the provided cursor.Writer (wrapping io.Writer).

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()

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

func StartOfLineDown(n int)

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

func StartOfLineUp(n int)

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

func TestCustomIOWriter(t *testing.T)

TestCustomIOWriter tests the cursor functions with a custom Writer.

func Up

func Up(n int)

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

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) Bottom

func (area *Area) 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 (*Area) Clear

func (area *Area) Clear()

Clear clears the content of the Area.

func (*Area) ClearLinesDown

func (area *Area) ClearLinesDown(n int)

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

func (*Area) ClearLinesUp

func (area *Area) ClearLinesUp(n int)

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

func (*Area) Down

func (area *Area) Down(n int)

Down moves the cursor of the area down one line.

func (*Area) DownAndClear

func (area *Area) DownAndClear(n int)

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

func (*Area) Move

func (area *Area) Move(x, y int)

Move moves the cursor relative by x and y.

func (*Area) StartOfLine

func (area *Area) StartOfLine()

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

func (*Area) StartOfLineDown

func (area *Area) StartOfLineDown(n int)

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

func (*Area) StartOfLineUp

func (area *Area) StartOfLineUp(n int)

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

func (*Area) Top

func (area *Area) Top()

Top moves the cursor to the top of the area. This is done by calculating how many lines were moved by Up and Down.

func (*Area) Up

func (area *Area) Up(n int)

Up moves the cursor of the area up one line.

func (*Area) UpAndClear

func (area *Area) UpAndClear(n int)

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

func (*Area) Update

func (area *Area) Update(content string)

Update overwrites the content of the Area and adjusts its height based on content.

func (Area) WithWriter

func (area Area) WithWriter(writer Writer) Area

WithWriter sets the custom writer.

type Cursor

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

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

func NewCursor() *Cursor

NewCursor creates a new Cursor instance writing to os.Stdout.

func (*Cursor) Clear

func (c *Cursor) Clear()

Clear clears the current position and moves the cursor to the left.

func (*Cursor) ClearLine

func (c *Cursor) ClearLine()

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

func (*Cursor) Down

func (c *Cursor) Down(n int)

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

func (*Cursor) Hide

func (c *Cursor) 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 (*Cursor) HorizontalAbsolute

func (c *Cursor) HorizontalAbsolute(n int)

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

func (*Cursor) Left

func (c *Cursor) Left(n int)

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

func (*Cursor) Right

func (c *Cursor) Right(n int)

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

func (*Cursor) Show

func (c *Cursor) 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 (*Cursor) Up

func (c *Cursor) Up(n int)

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

func (*Cursor) WithWriter

func (c *Cursor) WithWriter(w Writer) *Cursor

WithWriter allows for any arbitrary Writer to be used for cursor movement abstracted.

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