living_terminal

package module

v0.0.2 Latest Latest Go to latest Published: Sep 5, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jwpkg/living-terminal

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Line
- func NewLine(startText string) *Line
- func (lineUpdater *Line) Finish()
- func (lineUpdater *Line) Update(newText string)
type LivingComponent
type LivingLine
- func NewLivingLine(components ...LivingComponent) *LivingLine
- func (line *LivingLine) Finish()
- func (line *LivingLine) Update(components ...LivingComponent)
type LivingScroller
- func NewLivingScroller(text string) *LivingScroller
- func (scroller *LivingScroller) Finish()
- func (scroller *LivingScroller) Init(requestReRender chan bool)
- func (scroller *LivingScroller) Render() string
type LivingSpinner
- func NewLivingSpinner(spinner spinner.Spinner) *LivingSpinner
- func (spinner *LivingSpinner) Finish()
- func (spinner *LivingSpinner) Init(requestReRender chan bool)
- func (spinner *LivingSpinner) Render() string
type LivingText
- func NewLivingText(text string) *LivingText
- func (livingText *LivingText) Finish()
- func (livingText *LivingText) Init(requestReRender chan bool)
- func (livingText *LivingText) Render() string
- func (livingText *LivingText) Update(text string)
type ProgressBar
- func NewProgressBar() *ProgressBar
- func (progressBar *ProgressBar) Finish()
- func (progressBar *ProgressBar) Init(requestReRender chan bool)
- func (progressBar *ProgressBar) Render() string
- func (progressBar *ProgressBar) SetRange(min, max int)
- func (progressBar *ProgressBar) SetSize(size int)
- func (progressBar *ProgressBar) Update(current int)

Constants ¶

This section is empty.

Variables ¶

View Source

var OriginalStderr = os.Stderr

View Source

var OriginalStdin = os.Stdin

View Source

var OriginalStdout = os.Stdout

Functions ¶

This section is empty.

Types ¶

type Line ¶

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

Updatable line in the terminal

func NewLine ¶

func NewLine(startText string) *Line

func (*Line) Finish ¶

func (lineUpdater *Line) Finish()

func (*Line) Update ¶

func (lineUpdater *Line) Update(newText string)

type LivingComponent ¶

type LivingComponent interface {
	Init(requestReRender chan bool)
	Render() string
	Finish()
}

type LivingLine ¶

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

Updatable line in the terminal

func NewLivingLine ¶

func NewLivingLine(components ...LivingComponent) *LivingLine

func (*LivingLine) Finish ¶

func (line *LivingLine) Finish()

func (*LivingLine) Update ¶

func (line *LivingLine) Update(components ...LivingComponent)

type LivingScroller ¶ added in v0.0.2

type LivingScroller struct {
	Text string
	Size int

	CurrentFrame int
	Interval     time.Duration
	// contains filtered or unexported fields
}

func NewLivingScroller ¶ added in v0.0.2

func NewLivingScroller(text string) *LivingScroller

func (*LivingScroller) Finish ¶ added in v0.0.2

func (scroller *LivingScroller) Finish()

func (*LivingScroller) Init ¶ added in v0.0.2

func (scroller *LivingScroller) Init(requestReRender chan bool)

func (*LivingScroller) Render ¶ added in v0.0.2

func (scroller *LivingScroller) Render() string

type LivingSpinner ¶ added in v0.0.2

type LivingSpinner struct {
	Spinner spinner.Spinner
	// contains filtered or unexported fields
}

func NewLivingSpinner ¶ added in v0.0.2

func NewLivingSpinner(spinner spinner.Spinner) *LivingSpinner

func (*LivingSpinner) Finish ¶ added in v0.0.2

func (spinner *LivingSpinner) Finish()

func (*LivingSpinner) Init ¶ added in v0.0.2

func (spinner *LivingSpinner) Init(requestReRender chan bool)

func (*LivingSpinner) Render ¶ added in v0.0.2

func (spinner *LivingSpinner) Render() string

type LivingText ¶ added in v0.0.2

type LivingText struct {
	Text string
	// contains filtered or unexported fields
}

func NewLivingText ¶ added in v0.0.2

func NewLivingText(text string) *LivingText

func (*LivingText) Finish ¶ added in v0.0.2

func (livingText *LivingText) Finish()

func (*LivingText) Init ¶ added in v0.0.2

func (livingText *LivingText) Init(requestReRender chan bool)

func (*LivingText) Render ¶ added in v0.0.2

func (livingText *LivingText) Render() string

func (*LivingText) Update ¶ added in v0.0.2

func (livingText *LivingText) Update(text string)

type ProgressBar ¶ added in v0.0.2

type ProgressBar struct {
	Min     int
	Max     int
	Current int
	Size    int
	// contains filtered or unexported fields
}

func NewProgressBar ¶ added in v0.0.2

func NewProgressBar() *ProgressBar

func (*ProgressBar) Finish ¶ added in v0.0.2

func (progressBar *ProgressBar) Finish()

func (*ProgressBar) Init ¶ added in v0.0.2

func (progressBar *ProgressBar) Init(requestReRender chan bool)

func (*ProgressBar) Render ¶ added in v0.0.2

func (progressBar *ProgressBar) Render() string

func (*ProgressBar) SetRange ¶ added in v0.0.2

func (progressBar *ProgressBar) SetRange(min, max int)

func (*ProgressBar) SetSize ¶ added in v0.0.2

func (progressBar *ProgressBar) SetSize(size int)

func (*ProgressBar) Update ¶ added in v0.0.2

func (progressBar *ProgressBar) Update(current int)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples
basic-living
basic-update
custom-component
internal

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL