(v2) merge textarea API updates into v2-area

README.md

@@ -1,5 +1,4 @@
-Bubbles
-=======
+# Bubbles
 
 <p>
   <img src="https://stuff.charm.sh/bubbles/bubbles-github.png" width="233" alt="The Bubbles Logo">
@@ -18,17 +17,15 @@ applications. These components are used in production in [Glow][glow],
 [charm]: https://github.com/charmbracelet/charm
 [otherstuff]: https://github.com/charmbracelet/bubbletea/#bubble-tea-in-the-wild
 
-
 ## Spinner
 
 <img src="https://stuff.charm.sh/bubbles-examples/spinner.gif" width="400" alt="Spinner Example">
 
 A spinner, useful for indicating that some kind an operation is happening.
 There are a couple default ones, but you can also pass your own ”frames.”
 
-* [Example code, basic spinner](https://github.com/charmbracelet/bubbletea/tree/master/examples/spinner/main.go)
-* [Example code, various spinners](https://github.com/charmbracelet/bubbletea/tree/master/examples/spinners/main.go)
-
+- [Example code, basic spinner](https://github.com/charmbracelet/bubbletea/tree/master/examples/spinner/main.go)
+- [Example code, various spinners](https://github.com/charmbracelet/bubbletea/tree/master/examples/spinners/main.go)
 
 ## Text Input
 
@@ -38,20 +35,20 @@ A text input field, akin to an `<input type="text">` in HTML. Supports unicode,
 pasting, in-place scrolling when the value exceeds the width of the element and
 the common, and many customization options.
 
-* [Example code, one field](https://github.com/charmbracelet/bubbletea/tree/master/examples/textinput/main.go)
-* [Example code, many fields](https://github.com/charmbracelet/bubbletea/tree/master/examples/textinputs/main.go)
+- [Example code, one field](https://github.com/charmbracelet/bubbletea/tree/master/examples/textinput/main.go)
+- [Example code, many fields](https://github.com/charmbracelet/bubbletea/tree/master/examples/textinputs/main.go)
 
 ## Text Area
 
 <img src="https://stuff.charm.sh/bubbles-examples/textarea.gif" width="400" alt="Text Area Example">
 
 A text area field, akin to an `<textarea />` in HTML. Allows for input that
 spans multiple lines. Supports unicode, pasting, vertical scrolling when the
-value exceeds the width and height of the element,  and many customization
+value exceeds the width and height of the element, and many customization
 options.
 
-* [Example code, chat input](https://github.com/charmbracelet/bubbletea/tree/master/examples/chat/main.go)
-* [Example code, story time input](https://github.com/charmbracelet/bubbletea/tree/master/examples/textarea/main.go)
+- [Example code, chat input](https://github.com/charmbracelet/bubbletea/tree/master/examples/chat/main.go)
+- [Example code, story time input](https://github.com/charmbracelet/bubbletea/tree/master/examples/textarea/main.go)
 
 ## Table
 
@@ -60,7 +57,7 @@ options.
 A component for displaying and navigating tabular data (columns and rows).
 Supports vertical scrolling and many customization options.
 
-* [Example code, countries and populations](https://github.com/charmbracelet/bubbletea/tree/master/examples/table/main.go)
+- [Example code, countries and populations](https://github.com/charmbracelet/bubbletea/tree/master/examples/table/main.go)
 
 ## Progress
 
@@ -71,12 +68,11 @@ A simple, customizable progress meter, with optional animation via
 runes can be set to whatever you'd like. The percentage readout is customizable
 and can also be omitted entirely.
 
-* [Animated example](https://github.com/charmbracelet/bubbletea/blob/master/examples/progress-animated/main.go)
-* [Static example](https://github.com/charmbracelet/bubbletea/blob/master/examples/progress-static/main.go)
+- [Animated example](https://github.com/charmbracelet/bubbletea/blob/master/examples/progress-animated/main.go)
+- [Static example](https://github.com/charmbracelet/bubbletea/blob/master/examples/progress-static/main.go)
 
 [harmonica]: https://github.com/charmbracelet/harmonica
 
-
 ## Paginator
 
 <img src="https://stuff.charm.sh/bubbles-examples/pagination.gif" width="200" alt="Paginator Example">
@@ -86,8 +82,7 @@ Supports "dot-style" pagination (similar to what you might see on iOS) and
 numeric page numbering, but you could also just use this component for the
 logic and visualize pagination however you like.
 
-* [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/paginator/main.go)
-
+- [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/paginator/main.go)
 
 ## Viewport
 
@@ -97,14 +92,13 @@ A viewport for vertically scrolling content. Optionally includes standard
 pager keybindings and mouse wheel support. A high performance mode is available
 for applications which make use of the alternate screen buffer.
 
-* [Example code](https://github.com/charmbracelet/bubbletea/tree/master/examples/pager/main.go)
+- [Example code](https://github.com/charmbracelet/bubbletea/tree/master/examples/pager/main.go)
 
 This component is well complemented with [Reflow][reflow] for ANSI-aware
 indenting and text wrapping.
 
 [reflow]: https://github.com/muesli/reflow
 
-
 ## List
 
 <img src="https://stuff.charm.sh/bubbles-examples/list.gif" width="600" alt="List Example">
@@ -114,9 +108,9 @@ Features pagination, fuzzy filtering, auto-generated help, an activity spinner,
 and status messages, all of which can be enabled and disabled as needed.
 Extrapolated from [Glow][glow].
 
-* [Example code, default list](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-default/main.go)
-* [Example code, simple list](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-simple/main.go)
-* [Example code, all features](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-fancy/main.go)
+- [Example code, default list](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-default/main.go)
+- [Example code, simple list](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-simple/main.go)
+- [Example code, all features](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-fancy/main.go)
 
 ## File Picker
 
@@ -126,7 +120,7 @@ A customizable component for picking a file from the file system. Navigate
 through directories and select files, optionally limit to certain file
 extensions.
 
-* [Example code](https://github.com/charmbracelet/bubbletea/tree/master/examples/file-picker/main.go)
+- [Example code](https://github.com/charmbracelet/bubbletea/tree/master/examples/file-picker/main.go)
 
 ## Timer
 
@@ -135,8 +129,7 @@ can be customized as you like.
 
 <img src="https://stuff.charm.sh/bubbles-examples/timer.gif" width="400" alt="Timer example">
 
-* [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/timer/main.go)
-
+- [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/timer/main.go)
 
 ## Stopwatch
 
@@ -145,8 +138,7 @@ can be customized as you like.
 A simple, flexible component for counting up. The update frequency and output
 can be customized as you see fit.
 
-* [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/stopwatch/main.go)
-
+- [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/stopwatch/main.go)
 
 ## Help
 
@@ -157,8 +149,7 @@ from your keybindings. It features single and multi-line modes, which the user
 can optionally toggle between. It will truncate gracefully if the terminal is
 too wide for the content.
 
-* [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/help/main.go)
-
+- [Example code](https://github.com/charmbracelet/bubbletea/blob/master/examples/help/main.go)
 
 ## Key
 
@@ -197,42 +188,13 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 }
 ```
 
+## There’s more where that came from
 
-## Additional Bubbles
-
-<!-- in alphabetical order by author -->
-
-* [76creates/stickers](https://github.com/76creates/stickers): Responsive
-  flexbox and table components.
-* [calyptia/go-bubble-table](https://github.com/calyptia/go-bubble-table): An
-  interactive, customizable, scrollable table component.
-* [erikgeiser/promptkit](https://github.com/erikgeiser/promptkit): A collection
-  of common prompts for cases like selection, text input, and confirmation.
-  Each prompt comes with sensible defaults, remappable keybindings, any many
-  customization options.
-* [evertras/bubble-table](https://github.com/Evertras/bubble-table): Interactive,
-  customizable, paginated tables.
-* [knipferrc/teacup](https://github.com/knipferrc/teacup): Various handy
-  bubbles and utilities for building Bubble Tea applications.
-* [mritd/bubbles](https://github.com/mritd/bubbles): Some general-purpose
-  bubbles. Inputs with validation, menu selection, a modified progressbar, and
-  so on.
-* [kevm/bubbleo](https://github.com/KevM/bubbleo): A set of bubbles with a
-  focus on navigation: navigation stacks, breakcrumbs, menus and so on.
-* [treilik/bubbleboxer](https://github.com/treilik/bubbleboxer): Layout
-  multiple bubbles side-by-side in a layout-tree.
-* [treilik/bubblelister](https://github.com/treilik/bubblelister): An alternate
-  list that is scrollable without pagination and has the ability to contain
-  other bubbles as list items.
-
-If you’ve built a Bubble you think should be listed here, please create a Pull
-Request. Please note that for a project to be included, it must meet the
-following requirements:
-- The README has a demo GIF.
-- The README clearly states the purpose of the bubble along with an example on how to use it. 
-- The bubble must *always* be in a working state on its `main` branch.
-
-Thank you!
+To check out community-maintained Bubbles see [Charm &
+Friends](https://github.com/charm-and-friends/additional-bubbles). Made a cool Bubble
+that you want to share?
+[PRs](https://github.com/charm-and-friends/additional-bubbles?tab=readme-ov-file#what-is-a-complete-project)
+are welcome!
 
 ## Contributing
 
@@ -244,15 +206,15 @@ See [contributing][contribute].
 
 We’d love to hear your thoughts on this project. Feel free to drop us a note!
 
-* [Twitter](https://twitter.com/charmcli)
-* [The Fediverse](https://mastodon.social/@charmcli)
-* [Discord](https://charm.sh/chat)
+- [Twitter](https://twitter.com/charmcli)
+- [The Fediverse](https://mastodon.social/@charmcli)
+- [Discord](https://charm.sh/chat)
 
 ## License
 
 [MIT](https://github.com/charmbracelet/bubbletea/raw/master/LICENSE)
 
-***
+---
 
 Part of [Charm](https://charm.sh).
 

cursor/cursor.go

@@ -1,3 +1,5 @@
+// Package cursor provides a virtual cursor to support the textinput and
+// textarea elements.
 package cursor
 
 import (
@@ -51,25 +53,35 @@ func (c Mode) String() string {
 
 // Model is the Bubble Tea model for this cursor element.
 type Model struct {
-	BlinkSpeed time.Duration
-	// Style for styling the cursor block.
+	// Style styles the cursor block.
 	Style lipgloss.Style
-	// TextStyle is the style used for the cursor when it is hidden (when blinking).
-	// I.e. displaying normal text.
+
+	// TextStyle is the style used for the cursor when it is blinking
+	// (hidden), i.e. displaying normal text.
 	TextStyle lipgloss.Style
 
+	// BlinkSpeed is the speed at which the cursor blinks. This has no effect
+	// unless [CursorMode] is not set to [CursorBlink].
+	BlinkSpeed time.Duration
+
+	// Blink is the state of the cursor blink. When true, the cursor is hidden.
+	Blink bool
+
 	// char is the character under the cursor
 	char string
+
 	// The ID of this Model as it relates to other cursors
 	id int
+
 	// focus indicates whether the containing input is focused
 	focus bool
-	// Cursor Blink state.
-	Blink bool
+
 	// Used to manage cursor blink
 	blinkCtx *blinkCtx
+
 	// The ID of the blink message we're expecting to receive.
 	blinkTag int
+
 	// mode determines the behavior of the cursor
 	mode Mode
 }

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/MakeNowJust/heredoc v1.0.0
 	github.com/atotto/clipboard v0.1.4
-	github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250114201644-43a5b4dd0af0
+	github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123211610-443afa6fa0c1
 	github.com/charmbracelet/harmonica v0.2.0
 	github.com/charmbracelet/lipgloss/v2 v2.0.0-alpha.2.0.20250114171829-b67eb015d607
 	github.com/charmbracelet/x/ansi v0.7.0

go.sum

@@ -6,6 +6,14 @@ github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWp
 github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA=
 github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250114201644-43a5b4dd0af0 h1:BWjXQRSwBjoCpLeNu8zT93n+NHhZZhkQQLveXMmnkYc=
 github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250114201644-43a5b4dd0af0/go.mod h1:hT2875Ank3ylgW13kqu6cjDc9XIk9sE5JsOFYdl09b8=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123204203-55f6f9f70bf6 h1:L2+Kl71AsucUpl32AqmbjVv/4Ha7dwlSFwqrU4sAeTE=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123204203-55f6f9f70bf6/go.mod h1:hT2875Ank3ylgW13kqu6cjDc9XIk9sE5JsOFYdl09b8=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123210727-80fa20da7d7b h1:QqN3KApDbHJl+B1lVSir6GyRbxH7EA6U1SCDoxz8xYU=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123210727-80fa20da7d7b/go.mod h1:hT2875Ank3ylgW13kqu6cjDc9XIk9sE5JsOFYdl09b8=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123210853-99e3bbf892cd h1:1WsMNlPUaDXgJprIvWg+ZsXmc4GiL4KsBEFNZ3ymKeA=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123210853-99e3bbf892cd/go.mod h1:hT2875Ank3ylgW13kqu6cjDc9XIk9sE5JsOFYdl09b8=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123211610-443afa6fa0c1 h1:tktnM4YimEWSYd58iZlPDB3Xz25/r94VYZZsHK5zWL0=
+github.com/charmbracelet/bubbletea/v2 v2.0.0-alpha.2.0.20250123211610-443afa6fa0c1/go.mod h1:hT2875Ank3ylgW13kqu6cjDc9XIk9sE5JsOFYdl09b8=
 github.com/charmbracelet/colorprofile v0.1.9 h1:5JnfvX+I9D6rRNu8xK3pgIqknaBVTXHU9pGu1jkZxLw=
 github.com/charmbracelet/colorprofile v0.1.9/go.mod h1:+jpmObxZl1Dab3H3IMVIPSZTsKcFpjJUv97G0dLqM60=
 github.com/charmbracelet/harmonica v0.2.0 h1:8NxJWRWg/bzKqqEaaeFNipOu77YR5t8aSwG4pgaUBiQ=

progress/progress.go

@@ -182,15 +182,15 @@ func New(opts ...Option) Model {
 }
 
 // Init exists to satisfy the tea.Model interface.
-func (m Model) Init() (tea.Model, tea.Cmd) {
+func (m Model) Init() (Model, tea.Cmd) {
 	return m, nil
 }
 
 // Update is used to animate the progress bar during transitions. Use
 // SetPercent to create the command you'll need to trigger the animation.
 //
 // If you're rendering with ViewAs you won't need this.
-func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case FrameMsg:
 		if msg.id != m.id || msg.tag != m.tag {

stopwatch/stopwatch.go

@@ -86,7 +86,7 @@ func (m Model) Init() (Model, tea.Cmd) {
 
 // Start starts the stopwatch.
 func (m Model) Start() tea.Cmd {
-	return tea.Batch(func() tea.Msg {
+	return tea.Sequence(func() tea.Msg {
 		return StartStopMsg{ID: m.id, running: true}
 	}, tick(m.id, m.tag, m.Interval))
 }