v0.10.0

[meowgorithm]

Timer, stopwatch, bugfixes and quality-of-life improvements

🎊 Happy New Year! This is a big release with a couple new components a bunch of bug fixes and quality-of-life improvements across the board. Read on for highlights and details.

tl;dr

New

• Add timer component (thanks @caarlos0) feat: simple timer component #67
• Add stopwatch compoent (thanks @caarlos0) feat: stopwatch #68
• Viewports can now be initialized with a New() constructor at the package level Viewport quality-of-life improvements #92
• Viewports now have customizable keybindings via the key package Viewport quality-of-life improvements #92
• Viewport mouse wheel speed can be customized via the MouseWheelDelta property Viewport quality-of-life improvements #92
• The mouse in the viewport can be disabled entirely with MouseWheelEnabled property Viewport quality-of-life improvements #92

Changed

• NewModel() constructors are now deprecated in favor of New() Deprecate NewModel() constructors; use New() instead #93
• Expose list.FilterMachesMsg (thanks @jon4hz) expose list.FilterMachesMsg #77
• Allow key.Matches to accept multiple binding arguments Allow key.Matches to accept multiple binding arguments #84
• Spinners now ignore messages sent by other spinners Spin Safety #91

Fixed

• Update keybindings when setting items (thanks @paralin) fix(list): update keybindings when setting items #90
• Update keybindings after calling InsertItem on list Update keybindings after calling InsertItem on the list model #94
• Fix textinput infinite loop and panic (thanks @IllusionMan1212) fix textinput infinite loop and panic #89
• Fix bug where viewport doesn't render final lines Fix bug where viewport doesn't render final lines #74
• Fix bug where performance rendering could render one line too many Fix bug where viewport doesn't render final lines #74

---

Highlights

New: Timer

@caarlos0 added a simple timer Bubble for counting down.

See the example code and docs for details.

New: Stopwatch

To match the timer, @caarlos0 also added a simple stopwatch Bubble for counting up.

See the example code and docs for details.

Constructors

Prior to this update the convention was to create new models via a NewModel. We've changed that convention to New() for brevity and readability. NewModel() will continue to work in a deprecated fashion to ease the update process.

// Old
s := spinner.NewModel()

// New!
s := spinner.New()

Viewport improvements

As of this update you're strongly encouraged to initialize viewport models with the new New(width, height int) Model function, however it's currently optional to reduce friction when upgrading.

const width, height = 40, 80
vp := viewport.New(width, height)

Viewport models also now have a Style lipgloss.Style property you can use to apply a borders, margins, and padding directly to a viewport. Not more magic numbers, random constants, and fussy arithmetic.

vp.Style = lipgloss.NewStyle().
        BorderStyle(lipgloss.RoundedBorder()).
        BorderForeground(lipgloss.Color("62")).
        PaddingRight(2)

Keybindings are now defined via the key Bubble and can now be easily remapped.

vp.KeyMap.Up = key.NewBinding(WithKeys("up", "w"))

For details see the available bindings. Note that you can also just match on keys in the parent Update and call viewport methods like LineUp programmatically.

And, lastly, you can now disable the mouse wheel on a viewport with MouseWheelEnabled bool as well as change the mouse wheel scroll speed with the MouseWheelDelta int property.

See the viewport docs for details.

Spinner improvements

Now spinners only respond to their own spin messages so you don't need any more fancy logic when you want to control multiple spinners at once. To start a specific spinner you now call Tick() on the model instead of the package:

s := spinner.New()

// Old
cmd := spinner.Tick()

// New
cmd := s.Tick()

For posterity, you can still use the package-level Tick method in a deprecated fashion, however note that it will affect all spinners that process the resulting TickMsg as it did prior to the release.

For details see the spinner docs.

Key bindings

key.Binding currently allows you to bind against multiple keys:

binding := key.Binding(key.WithKeys("q", "ctrl+c"))

However, sometimes you may also want to match on multiple bindings:

left := key.Binding(key.WithKeys("h", "left"))
right := key.Binding(key.WithKeys("l", "right"))

case key.Matches(msg, left), key.Matches(msg, right):

This update expands key.Matches to accept multiple arguments so you can condense the above case statement to:

case key.Matches(msg, left, right):

For more on how keybindings work see the key docs.

---

New Contributors

• @caarlos0 made their first contribution feat: simple timer component #67
• @anirvan made their first contribution Fixed typo in README ("complimented" → "complemented") #81
• @paralin made their first contribution fix(list): update keybindings when setting items #90
• @IllusionMan1212 made their first contribution fix textinput infinite loop and panic #89
• @jon4hz made their first contribution expose list.FilterMachesMsg #77

Full Changelog: v0.9.0...v0.10.0

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or on Slack.

---

This discussion was created from the release v0.10.0.