Skip to content

Commit

Permalink
docs: autoupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed May 9, 2021
1 parent a2e2706 commit 8f55ac5
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<p align="center">
<strong><a href="#install">Get The Module</a></strong>
|
<strong><a href="https://pkg.go.dev/github.com/atomicgo/cursor" target="_blank">Documentation</a></strong>
<strong><a href="https://pkg.go.dev/github.com/atomicgo/cursor#section-documentation" target="_blank">Documentation</a></strong>
|
<strong><a href="https://github.com/atomicgo/atomicgo/blob/main/CONTRIBUTING.md" target="_blank">Contributing</a></strong>
|
Expand Down Expand Up @@ -84,6 +84,22 @@ func ClearLine()
```
ClearLine clears the current line and moves the cursor to it's start position.

#### func ClearLinesDown

```go
func ClearLinesDown(n int)
```
ClearLinesDown clears n lines downwards from the current position and moves the
cursor.

#### func ClearLinesUp

```go
func ClearLinesUp(n int)
```
ClearLinesUp clears n lines upwards from the current position and moves the
cursor.

#### func Down

```go
Expand Down Expand Up @@ -183,6 +199,37 @@ func UpAndClear(n int)
```
UpAndClear moves the cursor up by n lines, then clears the line.

#### type Area

```go
type Area struct {
}
```

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

#### func NewArea

```go
func NewArea() Area
```
NewArea returns a new Area.

#### func (*Area) Clear

```go
func (area *Area) Clear()
```
Clear clears the content of the Area.

#### func (*Area) Update

```go
func (area *Area) Update(content string)
```
Update overwrites the content of the Area.

---

> [AtomicGo.dev](https://atomicgo.dev) &nbsp;&middot;&nbsp;
Expand Down
Empty file added go.sum
Empty file.

0 comments on commit 8f55ac5

Please sign in to comment.