zscroll

README

zscroll-go

zscroll is a text scroller for panels or terminals.

Installation

Get the binary from GitHub Releases.

Or, if you have Go, you can install zscroll with the following command.

go get github.com/skmatz/zscroll-go/...

Usage

Now, refer to the original repository (here).

References

• noctuid/zscroll

Documentation

Index

• type Scroller
  • func NewScroller(text string, opt ScrollerOptions) (*Scroller, error)
  • func (s *Scroller) CurrentString() string
  • func (s *Scroller) Run() error
• type ScrollerOptions

Types

type Scroller

type Scroller struct {
	Text string

	AfterText   string
	BeforeText  string
	Delay       float64
	Length      int
	NewLine     bool
	PaddingText string
	Reverse     bool
	Scroll      bool
	Timeout     int
	// contains filtered or unexported fields
}

func NewScroller

func NewScroller(text string, opt ScrollerOptions) (*Scroller, error)

func (*Scroller) CurrentString

func (s *Scroller) CurrentString() string

func (*Scroller) Run

func (s *Scroller) Run() error

type ScrollerOptions

type ScrollerOptions struct {
	AfterText   string
	BeforeText  string
	Delay       float64
	Length      int
	NewLine     bool
	PaddingText string
	Reverse     bool
	Scroll      bool
	Timeout     int
}