README
¶
Marquee Bubble
A simple BubbleTea bubble component to generate marquees.
Usage
First, initialize a new marquee, then set the text to display, and optionally the width. If width is not defined, it's assumed from the text's length.
func NewMyModel() MyModel {
m := marquee.New()
m.SetText("Hello World")
m.SetWidth(100) // optional
return MyModel{marquee: m}
}
It supports two scrolling directions, left and right.
m.ScrollDirection = marquee.Right
You can also specify the scrolling speed (defaults to 250ms).
m.ScrollSpeed = 50 * time.Millisecond
And you can make it continuous:
m.SetContinuous(true)
Then, call scroll in your Init().
func(m MyModel) Init() tea.Cmd {
return m.marquee.Scroll
}
That's it. Check the documentation and the example directory for more detailed usage.
License
See LICENSE.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Model ¶
type Model struct {
ScrollSpeed time.Duration
// Style for styling the marquee block.
Style lipgloss.Style
// The direction in which the text will scroll.
ScrollDirection Direction
// contains filtered or unexported fields
}
Model is the Bubble Tea model for the marquee.
func (*Model) SetContinuous ¶
Sets if the text of the marquee should be continuous.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.