6 Commits

Author SHA1 Message Date
Maas Lalani
1e920595f2 feat(table): add SetColumns method to set columns 2022-09-27 13:11:34 -04:00
Maas Lalani
a4ed54327f chore: move cursor bubble to internal 2022-09-14 15:45:51 -04:00
Maas Lalani
a99b55cda1 Delegate Cursor Logic to cursor bubble (#181)
* refactor: remove cursor logic from textinput
* chore: Add Deprecated Fields to avoid breaking changes
* fix: Ctrl+A and typing moves to end bug
2022-09-14 10:44:10 -04:00
Raphael 'kena' Poss
062b257e8c fix(cursor): apply TextStyle inline (#230)
Co-authored-by: Maas Lalani <maas@lalani.dev>
2022-09-07 16:05:25 -04:00
Maas Lalani
8b3bfee06d docs: add table bubble to README 2022-09-06 13:28:31 -04:00
Maas Lalani
ff77858511 docs: change tea{,party} to bubbletea 2022-09-06 13:28:31 -04:00
5 changed files with 179 additions and 336 deletions

View File

@@ -26,8 +26,8 @@ applications. These components are used in production in [Glow][glow],
A spinner, useful for indicating that some kind an operation is happening. 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.” There are a couple default ones, but you can also pass your own ”frames.”
* [Example code, basic spinner](https://github.com/charmbracelet/tea/tree/master/examples/spinner/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/tea/tree/master/examples/spinners/main.go) * [Example code, various spinners](https://github.com/charmbracelet/bubbletea/tree/master/examples/spinners/main.go)
## Text Input ## Text Input
@@ -38,8 +38,8 @@ 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 pasting, in-place scrolling when the value exceeds the width of the element and
the common, and many customization options. the common, and many customization options.
* [Example code, one field](https://github.com/charmbracelet/tea/tree/master/examples/textinput/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/tea/tree/master/examples/textinputs/main.go) * [Example code, many fields](https://github.com/charmbracelet/bubbletea/tree/master/examples/textinputs/main.go)
## Text Area ## Text Area
@@ -50,9 +50,17 @@ 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. options.
* [Example code, chat input](https://github.com/charmbracelet/tea/tree/master/examples/chat/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/tea/tree/master/examples/textarea/main.go) * [Example code, story time input](https://github.com/charmbracelet/bubbletea/tree/master/examples/textarea/main.go)
## Table
<img src="https://stuff.charm.sh/bubbles-examples/table.gif" width="400" alt="Table Example">
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)
## Progress ## Progress
@@ -97,7 +105,7 @@ A viewport for vertically scrolling content. Optionally includes standard
pager keybindings and mouse wheel support. A high performance mode is available pager keybindings and mouse wheel support. A high performance mode is available
for applications which make use of the alternate screen buffer. for applications which make use of the alternate screen buffer.
* [Example code](https://github.com/charmbracelet/tea/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 This component is well complemented with [Reflow][reflow] for ANSI-aware
indenting and text wrapping. indenting and text wrapping.
@@ -118,9 +126,9 @@ Features pagination, fuzzy filtering, auto-generated help, an activity spinner,
and status messages, all of which can be enabled and disabled as needed. and status messages, all of which can be enabled and disabled as needed.
Extrapolated from [Glow][glow]. Extrapolated from [Glow][glow].
* [Example code, default list](https://github.com/charmbracelet/tea/tree/master/examples/list-default/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/tea/tree/master/examples/list-simple/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/tea/tree/master/examples/list-fancy/main.go) * [Example code, all features](https://github.com/charmbracelet/bubbletea/tree/master/examples/list-fancy/main.go)
## Timer ## Timer
@@ -228,7 +236,7 @@ If youve built a Bubble you think should be listed here,
## License ## License
[MIT](https://github.com/charmbracelet/teaparty/raw/master/LICENSE) [MIT](https://github.com/charmbracelet/bubbletea/raw/master/LICENSE)
*** ***

View File

@@ -70,8 +70,8 @@ type Model struct {
blinkCtx *blinkCtx blinkCtx *blinkCtx
// The ID of the blink message we're expecting to receive. // The ID of the blink message we're expecting to receive.
blinkTag int blinkTag int
// cursorMode determines the behavior of the cursor // mode determines the behavior of the cursor
cursorMode Mode mode Mode
} }
// New creates a new model with default settings. // New creates a new model with default settings.
@@ -80,7 +80,7 @@ func New() Model {
BlinkSpeed: defaultBlinkSpeed, BlinkSpeed: defaultBlinkSpeed,
Blink: true, Blink: true,
cursorMode: CursorBlink, mode: CursorBlink,
blinkCtx: &blinkCtx{ blinkCtx: &blinkCtx{
ctx: context.Background(), ctx: context.Background(),
@@ -94,7 +94,7 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
case initialBlinkMsg: case initialBlinkMsg:
// We accept all initialBlinkMsgs generated by the Blink command. // We accept all initialBlinkMsgs generated by the Blink command.
if m.cursorMode != CursorBlink || !m.focus { if m.mode != CursorBlink || !m.focus {
return m, nil return m, nil
} }
@@ -106,7 +106,7 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
// only exactly when it should. // only exactly when it should.
// Is this model blink-able? // Is this model blink-able?
if m.cursorMode != CursorBlink || !m.focus { if m.mode != CursorBlink || !m.focus {
return m, nil return m, nil
} }
@@ -116,7 +116,7 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
} }
var cmd tea.Cmd var cmd tea.Cmd
if m.cursorMode == CursorBlink { if m.mode == CursorBlink {
m.Blink = !m.Blink m.Blink = !m.Blink
cmd = m.BlinkCmd() cmd = m.BlinkCmd()
} }
@@ -128,18 +128,18 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
return m, nil return m, nil
} }
// CursorMode returns the model's cursor mode. For available cursor modes, see // Mode returns the model's cursor mode. For available cursor modes, see
// type CursorMode. // type Mode.
func (m Model) CursorMode() Mode { func (m Model) Mode() Mode {
return m.cursorMode return m.mode
} }
// SetCursorMode sets the model's cursor mode. This method returns a command. // SetMode sets the model's cursor mode. This method returns a command.
// //
// For available cursor modes, see type CursorMode. // For available cursor modes, see type CursorMode.
func (m *Model) SetCursorMode(mode Mode) tea.Cmd { func (m *Model) SetMode(mode Mode) tea.Cmd {
m.cursorMode = mode m.mode = mode
m.Blink = m.cursorMode == CursorHide || !m.focus m.Blink = m.mode == CursorHide || !m.focus
if mode == CursorBlink { if mode == CursorBlink {
return Blink return Blink
} }
@@ -148,7 +148,7 @@ func (m *Model) SetCursorMode(mode Mode) tea.Cmd {
// BlinkCmd is an command used to manage cursor blinking. // BlinkCmd is an command used to manage cursor blinking.
func (m *Model) BlinkCmd() tea.Cmd { func (m *Model) BlinkCmd() tea.Cmd {
if m.cursorMode != CursorBlink { if m.mode != CursorBlink {
return nil return nil
} }
@@ -179,9 +179,9 @@ func Blink() tea.Msg {
// Focus focuses the cursor to allow it to blink if desired. // Focus focuses the cursor to allow it to blink if desired.
func (m *Model) Focus() tea.Cmd { func (m *Model) Focus() tea.Cmd {
m.focus = true m.focus = true
m.Blink = m.cursorMode == CursorHide // show the cursor unless we've explicitly hidden it m.Blink = m.mode == CursorHide // show the cursor unless we've explicitly hidden it
if m.cursorMode == CursorBlink && m.focus { if m.mode == CursorBlink && m.focus {
return m.BlinkCmd() return m.BlinkCmd()
} }
return nil return nil
@@ -201,7 +201,7 @@ func (m *Model) SetChar(char string) {
// View displays the cursor. // View displays the cursor.
func (m Model) View() string { func (m Model) View() string {
if m.Blink { if m.Blink {
return m.TextStyle.Render(m.char) return m.TextStyle.Inline(true).Render(m.char)
} }
return m.Style.Inline(true).Reverse(true).Render(m.char) return m.Style.Inline(true).Reverse(true).Render(m.char)
} }

View File

@@ -264,6 +264,12 @@ func (m *Model) SetRows(r []Row) {
m.UpdateViewport() m.UpdateViewport()
} }
// SetColumns set a new columns state.
func (m *Model) SetColumns(c []Column) {
m.cols = c
m.UpdateViewport()
}
// SetWidth sets the width of the viewport of the table. // SetWidth sets the width of the viewport of the table.
func (m *Model) SetWidth(w int) { func (m *Model) SetWidth(w int) {
m.viewport.Width = w m.viewport.Width = w

View File

@@ -6,7 +6,7 @@ import (
"unicode" "unicode"
"github.com/atotto/clipboard" "github.com/atotto/clipboard"
"github.com/charmbracelet/bubbles/cursor" "github.com/charmbracelet/bubbles/internal/cursor"
"github.com/charmbracelet/bubbles/key" "github.com/charmbracelet/bubbles/key"
"github.com/charmbracelet/bubbles/viewport" "github.com/charmbracelet/bubbles/viewport"
tea "github.com/charmbracelet/bubbletea" tea "github.com/charmbracelet/bubbletea"

View File

@@ -1,48 +1,17 @@
package textinput package textinput
import ( import (
"context"
"strings" "strings"
"sync"
"time" "time"
"unicode" "unicode"
"github.com/atotto/clipboard" "github.com/atotto/clipboard"
"github.com/charmbracelet/bubbles/internal/cursor"
tea "github.com/charmbracelet/bubbletea" tea "github.com/charmbracelet/bubbletea"
"github.com/charmbracelet/lipgloss" "github.com/charmbracelet/lipgloss"
rw "github.com/mattn/go-runewidth" rw "github.com/mattn/go-runewidth"
) )
const defaultBlinkSpeed = time.Millisecond * 530
// Internal ID management for text inputs. Necessary for blink integrity when
// multiple text inputs are involved.
var (
lastID int
idMtx sync.Mutex
)
// Return the next ID we should use on the Model.
func nextID() int {
idMtx.Lock()
defer idMtx.Unlock()
lastID++
return lastID
}
// initialBlinkMsg initializes cursor blinking.
type initialBlinkMsg struct{}
// blinkMsg signals that the cursor should blink. It contains metadata that
// allows us to tell if the blink message is the one we're expecting.
type blinkMsg struct {
id int
tag int
}
// blinkCanceled is sent when a blink operation is canceled.
type blinkCanceled struct{}
// Internal messages for clipboard operations. // Internal messages for clipboard operations.
type pasteMsg string type pasteMsg string
type pasteErrMsg struct{ error } type pasteErrMsg struct{ error }
@@ -65,32 +34,6 @@ const (
// EchoOnEdit. // EchoOnEdit.
) )
// blinkCtx manages cursor blinking.
type blinkCtx struct {
ctx context.Context
cancel context.CancelFunc
}
// CursorMode describes the behavior of the cursor.
type CursorMode int
// Available cursor modes.
const (
CursorBlink CursorMode = iota
CursorStatic
CursorHide
)
// String returns a the cursor mode in a human-readable format. This method is
// provisional and for informational purposes only.
func (c CursorMode) String() string {
return [...]string{
"blink",
"static",
"hidden",
}[c]
}
// ValidateFunc is a function that returns an error if the input is invalid. // ValidateFunc is a function that returns an error if the input is invalid.
type ValidateFunc func(string) error type ValidateFunc func(string) error
@@ -101,9 +44,13 @@ type Model struct {
// General settings. // General settings.
Prompt string Prompt string
Placeholder string Placeholder string
BlinkSpeed time.Duration
EchoMode EchoMode EchoMode EchoMode
EchoCharacter rune EchoCharacter rune
Cursor cursor.Model
// Deprecated: use cursor.BlinkSpeed instead.
// This is unused and will be removed in the future.
BlinkSpeed time.Duration
// Styles. These will be applied as inline styles. // Styles. These will be applied as inline styles.
// //
@@ -124,12 +71,6 @@ type Model struct {
// viewport. If 0 or less this setting is ignored. // viewport. If 0 or less this setting is ignored.
Width int Width int
// The ID of this Model as it relates to other textinput Models.
id int
// The ID of the blink message we're expecting to receive.
blinkTag int
// Underlying text value. // Underlying text value.
value []rune value []rune
@@ -137,9 +78,6 @@ type Model struct {
// component. When false, ignore keyboard input and hide the cursor. // component. When false, ignore keyboard input and hide the cursor.
focus bool focus bool
// Cursor blink state.
blink bool
// Cursor position. // Cursor position.
pos int pos int
@@ -148,12 +86,6 @@ type Model struct {
offset int offset int
offsetRight int offsetRight int
// Used to manage cursor blink
blinkCtx *blinkCtx
// cursorMode determines the behavior of the cursor
cursorMode CursorMode
// Validate is a function that checks whether or not the text within the // Validate is a function that checks whether or not the text within the
// input is valid. If it is not valid, the `Err` field will be set to the // input is valid. If it is not valid, the `Err` field will be set to the
// error returned by the function. If the function is not defined, all // error returned by the function. If the function is not defined, all
@@ -165,21 +97,14 @@ type Model struct {
func New() Model { func New() Model {
return Model{ return Model{
Prompt: "> ", Prompt: "> ",
BlinkSpeed: defaultBlinkSpeed,
EchoCharacter: '*', EchoCharacter: '*',
CharLimit: 0, CharLimit: 0,
PlaceholderStyle: lipgloss.NewStyle().Foreground(lipgloss.Color("240")), PlaceholderStyle: lipgloss.NewStyle().Foreground(lipgloss.Color("240")),
Cursor: cursor.New(),
id: nextID(),
value: nil, value: nil,
focus: false, focus: false,
blink: true,
pos: 0, pos: 0,
cursorMode: CursorBlink,
blinkCtx: &blinkCtx{
ctx: context.Background(),
},
} }
} }
@@ -205,8 +130,8 @@ func (m *Model) SetValue(s string) {
} else { } else {
m.value = runes m.value = runes
} }
if m.pos == 0 || m.pos > len(m.value) { if m.pos > len(m.value) {
m.setCursor(len(m.value)) m.SetCursor(len(m.value))
} }
m.handleOverflow() m.handleOverflow()
} }
@@ -216,74 +141,26 @@ func (m Model) Value() string {
return string(m.value) return string(m.value)
} }
// Cursor returns the cursor position. // Position returns the cursor position.
func (m Model) Cursor() int { func (m Model) Position() int {
return m.pos return m.pos
} }
// Blink returns whether or not to draw the cursor.
func (m Model) Blink() bool {
return m.blink
}
// SetCursor moves the cursor to the given position. If the position is // SetCursor moves the cursor to the given position. If the position is
// out of bounds the cursor will be moved to the start or end accordingly. // out of bounds the cursor will be moved to the start or end accordingly.
func (m *Model) SetCursor(pos int) { func (m *Model) SetCursor(pos int) {
m.setCursor(pos)
}
// setCursor moves the cursor to the given position and returns whether or not
// the cursor blink should be reset. If the position is out of bounds the
// cursor will be moved to the start or end accordingly.
func (m *Model) setCursor(pos int) bool {
m.pos = clamp(pos, 0, len(m.value)) m.pos = clamp(pos, 0, len(m.value))
m.handleOverflow() m.handleOverflow()
// Show the cursor unless it's been explicitly hidden
m.blink = m.cursorMode == CursorHide
// Reset cursor blink if necessary
return m.cursorMode == CursorBlink
} }
// CursorStart moves the cursor to the start of the input field. // CursorStart moves the cursor to the start of the input field.
func (m *Model) CursorStart() { func (m *Model) CursorStart() {
m.cursorStart() m.SetCursor(0)
}
// cursorStart moves the cursor to the start of the input field and returns
// whether or not the curosr blink should be reset.
func (m *Model) cursorStart() bool {
return m.setCursor(0)
} }
// CursorEnd moves the cursor to the end of the input field. // CursorEnd moves the cursor to the end of the input field.
func (m *Model) CursorEnd() { func (m *Model) CursorEnd() {
m.cursorEnd() m.SetCursor(len(m.value))
}
// CursorMode returns the model's cursor mode. For available cursor modes, see
// type CursorMode.
func (m Model) CursorMode() CursorMode {
return m.cursorMode
}
// SetCursorMode sets the model's cursor mode. This method returns a command.
//
// For available cursor modes, see type CursorMode.
func (m *Model) SetCursorMode(mode CursorMode) tea.Cmd {
m.cursorMode = mode
m.blink = m.cursorMode == CursorHide || !m.focus
if mode == CursorBlink {
return Blink
}
return nil
}
// cursorEnd moves the cursor to the end of the input field and returns whether
// the cursor should blink should reset.
func (m *Model) cursorEnd() bool {
return m.setCursor(len(m.value))
} }
// Focused returns the focus state on the model. // Focused returns the focus state on the model.
@@ -295,31 +172,24 @@ func (m Model) Focused() bool {
// receive keyboard input and the cursor will be hidden. // receive keyboard input and the cursor will be hidden.
func (m *Model) Focus() tea.Cmd { func (m *Model) Focus() tea.Cmd {
m.focus = true m.focus = true
m.blink = m.cursorMode == CursorHide // show the cursor unless we've explicitly hidden it return m.Cursor.Focus()
if m.cursorMode == CursorBlink && m.focus {
return m.blinkCmd()
}
return nil
} }
// Blur removes the focus state on the model. When the model is blurred it can // Blur removes the focus state on the model. When the model is blurred it can
// not receive keyboard input and the cursor will be hidden. // not receive keyboard input and the cursor will be hidden.
func (m *Model) Blur() { func (m *Model) Blur() {
m.focus = false m.focus = false
m.blink = true m.Cursor.Blur()
} }
// Reset sets the input to its default state with no input. Returns whether // Reset sets the input to its default state with no input.
// or not the cursor blink should reset. func (m *Model) Reset() {
func (m *Model) Reset() bool {
m.value = nil m.value = nil
return m.setCursor(0) m.SetCursor(0)
} }
// handle a clipboard paste event, if supported. Returns whether or not the // handle a clipboard paste event, if supported.
// cursor blink should reset. func (m *Model) handlePaste(v string) {
func (m *Model) handlePaste(v string) bool {
paste := []rune(v) paste := []rune(v)
var availSpace int var availSpace int
@@ -329,7 +199,7 @@ func (m *Model) handlePaste(v string) bool {
// If the char limit's been reached cancel // If the char limit's been reached cancel
if m.CharLimit > 0 && availSpace <= 0 { if m.CharLimit > 0 && availSpace <= 0 {
return false return
} }
// If there's not enough space to paste the whole thing cut the pasted // If there's not enough space to paste the whole thing cut the pasted
@@ -366,8 +236,7 @@ func (m *Model) handlePaste(v string) bool {
m.pos = oldPos m.pos = oldPos
} }
// Reset blink state if necessary and run overflow checks m.SetCursor(m.pos)
return m.setCursor(m.pos)
} }
// If a max width is defined, perform some logic to treat the visible area // If a max width is defined, perform some logic to treat the visible area
@@ -415,31 +284,30 @@ func (m *Model) handleOverflow() {
} }
} }
// deleteBeforeCursor deletes all text before the cursor. Returns whether or // deleteBeforeCursor deletes all text before the cursor.
// not the cursor blink should be reset. func (m *Model) deleteBeforeCursor() {
func (m *Model) deleteBeforeCursor() bool {
m.value = m.value[m.pos:] m.value = m.value[m.pos:]
m.offset = 0 m.offset = 0
return m.setCursor(0) m.SetCursor(0)
} }
// deleteAfterCursor deletes all text after the cursor. Returns whether or not // deleteAfterCursor deletes all text after the cursor. If input is masked
// the cursor blink should be reset. If input is masked delete everything after // delete everything after the cursor so as not to reveal word breaks in the
// the cursor so as not to reveal word breaks in the masked input. // masked input.
func (m *Model) deleteAfterCursor() bool { func (m *Model) deleteAfterCursor() {
m.value = m.value[:m.pos] m.value = m.value[:m.pos]
return m.setCursor(len(m.value)) m.SetCursor(len(m.value))
} }
// deleteWordLeft deletes the word left to the cursor. Returns whether or not // deleteWordLeft deletes the word left to the cursor.
// the cursor blink should be reset. func (m *Model) deleteWordLeft() {
func (m *Model) deleteWordLeft() bool {
if m.pos == 0 || len(m.value) == 0 { if m.pos == 0 || len(m.value) == 0 {
return false return
} }
if m.EchoMode != EchoNormal { if m.EchoMode != EchoNormal {
return m.deleteBeforeCursor() m.deleteBeforeCursor()
return
} }
// Linter note: it's critical that we acquire the initial cursor position // Linter note: it's critical that we acquire the initial cursor position
@@ -447,22 +315,22 @@ func (m *Model) deleteWordLeft() bool {
// call into the corresponding if clause does not apply here. // call into the corresponding if clause does not apply here.
oldPos := m.pos //nolint:ifshort oldPos := m.pos //nolint:ifshort
blink := m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
for unicode.IsSpace(m.value[m.pos]) { for unicode.IsSpace(m.value[m.pos]) {
if m.pos <= 0 { if m.pos <= 0 {
break break
} }
// ignore series of whitespace before cursor // ignore series of whitespace before cursor
blink = m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
} }
for m.pos > 0 { for m.pos > 0 {
if !unicode.IsSpace(m.value[m.pos]) { if !unicode.IsSpace(m.value[m.pos]) {
blink = m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
} else { } else {
if m.pos > 0 { if m.pos > 0 {
// keep the previous space // keep the previous space
blink = m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
} }
break break
} }
@@ -473,27 +341,26 @@ func (m *Model) deleteWordLeft() bool {
} else { } else {
m.value = append(m.value[:m.pos], m.value[oldPos:]...) m.value = append(m.value[:m.pos], m.value[oldPos:]...)
} }
return blink
} }
// deleteWordRight deletes the word right to the cursor. Returns whether or not // deleteWordRight deletes the word right to the cursor If input is masked
// the cursor blink should be reset. If input is masked delete everything after // delete everything after the cursor so as not to reveal word breaks in the
// the cursor so as not to reveal word breaks in the masked input. // masked input.
func (m *Model) deleteWordRight() bool { func (m *Model) deleteWordRight() {
if m.pos >= len(m.value) || len(m.value) == 0 { if m.pos >= len(m.value) || len(m.value) == 0 {
return false return
} }
if m.EchoMode != EchoNormal { if m.EchoMode != EchoNormal {
return m.deleteAfterCursor() m.deleteAfterCursor()
return
} }
oldPos := m.pos oldPos := m.pos
m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
for unicode.IsSpace(m.value[m.pos]) { for unicode.IsSpace(m.value[m.pos]) {
// ignore series of whitespace after cursor // ignore series of whitespace after cursor
m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
if m.pos >= len(m.value) { if m.pos >= len(m.value) {
break break
@@ -502,7 +369,7 @@ func (m *Model) deleteWordRight() bool {
for m.pos < len(m.value) { for m.pos < len(m.value) {
if !unicode.IsSpace(m.value[m.pos]) { if !unicode.IsSpace(m.value[m.pos]) {
m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
} else { } else {
break break
} }
@@ -514,26 +381,25 @@ func (m *Model) deleteWordRight() bool {
m.value = append(m.value[:oldPos], m.value[m.pos:]...) m.value = append(m.value[:oldPos], m.value[m.pos:]...)
} }
return m.setCursor(oldPos) m.SetCursor(oldPos)
} }
// wordLeft moves the cursor one word to the left. Returns whether or not the // wordLeft moves the cursor one word to the left. If input is masked, move
// cursor blink should be reset. If input is masked, move input to the start // input to the start so as not to reveal word breaks in the masked input.
// so as not to reveal word breaks in the masked input. func (m *Model) wordLeft() {
func (m *Model) wordLeft() bool {
if m.pos == 0 || len(m.value) == 0 { if m.pos == 0 || len(m.value) == 0 {
return false return
} }
if m.EchoMode != EchoNormal { if m.EchoMode != EchoNormal {
return m.cursorStart() m.CursorStart()
return
} }
blink := false
i := m.pos - 1 i := m.pos - 1
for i >= 0 { for i >= 0 {
if unicode.IsSpace(m.value[i]) { if unicode.IsSpace(m.value[i]) {
blink = m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
i-- i--
} else { } else {
break break
@@ -542,33 +408,30 @@ func (m *Model) wordLeft() bool {
for i >= 0 { for i >= 0 {
if !unicode.IsSpace(m.value[i]) { if !unicode.IsSpace(m.value[i]) {
blink = m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
i-- i--
} else { } else {
break break
} }
} }
return blink
} }
// wordRight moves the cursor one word to the right. Returns whether or not the // wordRight moves the cursor one word to the right. If the input is masked,
// cursor blink should be reset. If the input is masked, move input to the end // move input to the end so as not to reveal word breaks in the masked input.
// so as not to reveal word breaks in the masked input. func (m *Model) wordRight() {
func (m *Model) wordRight() bool {
if m.pos >= len(m.value) || len(m.value) == 0 { if m.pos >= len(m.value) || len(m.value) == 0 {
return false return
} }
if m.EchoMode != EchoNormal { if m.EchoMode != EchoNormal {
return m.cursorEnd() m.CursorEnd()
return
} }
blink := false
i := m.pos i := m.pos
for i < len(m.value) { for i < len(m.value) {
if unicode.IsSpace(m.value[i]) { if unicode.IsSpace(m.value[i]) {
blink = m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
i++ i++
} else { } else {
break break
@@ -577,14 +440,12 @@ func (m *Model) wordRight() bool {
for i < len(m.value) { for i < len(m.value) {
if !unicode.IsSpace(m.value[i]) { if !unicode.IsSpace(m.value[i]) {
blink = m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
i++ i++
} else { } else {
break break
} }
} }
return blink
} }
func (m Model) echoTransform(v string) string { func (m Model) echoTransform(v string) string {
@@ -602,11 +463,12 @@ func (m Model) echoTransform(v string) string {
// Update is the Bubble Tea update loop. // Update is the Bubble Tea update loop.
func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) { func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
if !m.focus { if !m.focus {
m.blink = true
return m, nil return m, nil
} }
var resetBlink bool // Let's remember where the position of the cursor currently is so that if
// the cursor position changes, we can reset the blink.
oldPos := m.pos //nolint
switch msg := msg.(type) { switch msg := msg.(type) {
case tea.KeyMsg: case tea.KeyMsg:
@@ -615,59 +477,59 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
m.Err = nil m.Err = nil
if msg.Alt { if msg.Alt {
resetBlink = m.deleteWordLeft() m.deleteWordLeft()
} else { } else {
if len(m.value) > 0 { if len(m.value) > 0 {
m.value = append(m.value[:max(0, m.pos-1)], m.value[m.pos:]...) m.value = append(m.value[:max(0, m.pos-1)], m.value[m.pos:]...)
if m.pos > 0 { if m.pos > 0 {
resetBlink = m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
} }
} }
} }
case tea.KeyLeft, tea.KeyCtrlB: case tea.KeyLeft, tea.KeyCtrlB:
if msg.Alt { // alt+left arrow, back one word if msg.Alt { // alt+left arrow, back one word
resetBlink = m.wordLeft() m.wordLeft()
break break
} }
if m.pos > 0 { // left arrow, ^F, back one character if m.pos > 0 { // left arrow, ^F, back one character
resetBlink = m.setCursor(m.pos - 1) m.SetCursor(m.pos - 1)
} }
case tea.KeyRight, tea.KeyCtrlF: case tea.KeyRight, tea.KeyCtrlF:
if msg.Alt { // alt+right arrow, forward one word if msg.Alt { // alt+right arrow, forward one word
resetBlink = m.wordRight() m.wordRight()
break break
} }
if m.pos < len(m.value) { // right arrow, ^F, forward one character if m.pos < len(m.value) { // right arrow, ^F, forward one character
resetBlink = m.setCursor(m.pos + 1) m.SetCursor(m.pos + 1)
} }
case tea.KeyCtrlW: // ^W, delete word left of cursor case tea.KeyCtrlW: // ^W, delete word left of cursor
resetBlink = m.deleteWordLeft() m.deleteWordLeft()
case tea.KeyHome, tea.KeyCtrlA: // ^A, go to beginning case tea.KeyHome, tea.KeyCtrlA: // ^A, go to beginning
resetBlink = m.cursorStart() m.CursorStart()
case tea.KeyDelete, tea.KeyCtrlD: // ^D, delete char under cursor case tea.KeyDelete, tea.KeyCtrlD: // ^D, delete char under cursor
if len(m.value) > 0 && m.pos < len(m.value) { if len(m.value) > 0 && m.pos < len(m.value) {
m.value = append(m.value[:m.pos], m.value[m.pos+1:]...) m.value = append(m.value[:m.pos], m.value[m.pos+1:]...)
} }
case tea.KeyCtrlE, tea.KeyEnd: // ^E, go to end case tea.KeyCtrlE, tea.KeyEnd: // ^E, go to end
resetBlink = m.cursorEnd() m.CursorEnd()
case tea.KeyCtrlK: // ^K, kill text after cursor case tea.KeyCtrlK: // ^K, kill text after cursor
resetBlink = m.deleteAfterCursor() m.deleteAfterCursor()
case tea.KeyCtrlU: // ^U, kill text before cursor case tea.KeyCtrlU: // ^U, kill text before cursor
resetBlink = m.deleteBeforeCursor() m.deleteBeforeCursor()
case tea.KeyCtrlV: // ^V paste case tea.KeyCtrlV: // ^V paste
return m, Paste return m, Paste
case tea.KeyRunes, tea.KeySpace: // input regular characters case tea.KeyRunes, tea.KeySpace: // input regular characters
if msg.Alt && len(msg.Runes) == 1 { if msg.Alt && len(msg.Runes) == 1 {
if msg.Runes[0] == 'd' { // alt+d, delete word right of cursor if msg.Runes[0] == 'd' { // alt+d, delete word right of cursor
resetBlink = m.deleteWordRight() m.deleteWordRight()
break break
} }
if msg.Runes[0] == 'b' { // alt+b, back one word if msg.Runes[0] == 'b' { // alt+b, back one word
resetBlink = m.wordLeft() m.wordLeft()
break break
} }
if msg.Runes[0] == 'f' { // alt+f, forward one word if msg.Runes[0] == 'f' { // alt+f, forward one word
resetBlink = m.wordRight() m.wordRight()
break break
} }
} }
@@ -681,59 +543,31 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
value = append(value[:m.pos], append(runes, value[m.pos:]...)...) value = append(value[:m.pos], append(runes, value[m.pos:]...)...)
m.SetValue(string(value)) m.SetValue(string(value))
if m.Err == nil { if m.Err == nil {
resetBlink = m.setCursor(m.pos + len(runes)) m.SetCursor(m.pos + len(runes))
} }
} }
} }
case initialBlinkMsg:
// We accept all initialBlinkMsgs genrated by the Blink command.
if m.cursorMode != CursorBlink || !m.focus {
return m, nil
}
cmd := m.blinkCmd()
return m, cmd
case blinkMsg:
// We're choosy about whether to accept blinkMsgs so that our cursor
// only exactly when it should.
// Is this model blinkable?
if m.cursorMode != CursorBlink || !m.focus {
return m, nil
}
// Were we expecting this blink message?
if msg.id != m.id || msg.tag != m.blinkTag {
return m, nil
}
var cmd tea.Cmd
if m.cursorMode == CursorBlink {
m.blink = !m.blink
cmd = m.blinkCmd()
}
return m, cmd
case blinkCanceled: // no-op
return m, nil
case pasteMsg: case pasteMsg:
resetBlink = m.handlePaste(string(msg)) m.handlePaste(string(msg))
case pasteErrMsg: case pasteErrMsg:
m.Err = msg m.Err = msg
} }
var cmds []tea.Cmd
var cmd tea.Cmd var cmd tea.Cmd
if resetBlink {
cmd = m.blinkCmd() m.Cursor, cmd = m.Cursor.Update(msg)
cmds = append(cmds, cmd)
if oldPos != m.pos {
m.Cursor.Blink = false
cmds = append(cmds, m.Cursor.BlinkCmd())
} }
m.handleOverflow() m.handleOverflow()
return m, cmd return m, tea.Batch(cmds...)
} }
// View renders the textinput in its current state. // View renders the textinput in its current state.
@@ -750,10 +584,13 @@ func (m Model) View() string {
v := styleText(m.echoTransform(string(value[:pos]))) v := styleText(m.echoTransform(string(value[:pos])))
if pos < len(value) { if pos < len(value) {
v += m.cursorView(m.echoTransform(string(value[pos]))) // cursor and text under it char := m.echoTransform(string(value[pos]))
m.Cursor.SetChar(char)
v += m.Cursor.View() // cursor and text under it
v += styleText(m.echoTransform(string(value[pos+1:]))) // text after cursor v += styleText(m.echoTransform(string(value[pos+1:]))) // text after cursor
} else { } else {
v += m.cursorView(" ") m.Cursor.SetChar(" ")
v += m.Cursor.View()
} }
// If a max width and background color were set fill the empty spaces with // If a max width and background color were set fill the empty spaces with
@@ -778,12 +615,9 @@ func (m Model) placeholderView() string {
style = m.PlaceholderStyle.Inline(true).Render style = m.PlaceholderStyle.Inline(true).Render
) )
// Cursor m.Cursor.TextStyle = m.PlaceholderStyle
if m.blink { m.Cursor.SetChar(p[:1])
v += m.cursorView(style(p[:1])) v += m.Cursor.View()
} else {
v += m.cursorView(p[:1])
}
// The rest of the placeholder text // The rest of the placeholder text
v += style(p[1:]) v += style(p[1:])
@@ -791,42 +625,9 @@ func (m Model) placeholderView() string {
return m.PromptStyle.Render(m.Prompt) + v return m.PromptStyle.Render(m.Prompt) + v
} }
// cursorView styles the cursor.
func (m Model) cursorView(v string) string {
if m.blink {
return m.TextStyle.Render(v)
}
return m.CursorStyle.Inline(true).Reverse(true).Render(v)
}
// blinkCmd is an internal command used to manage cursor blinking.
func (m *Model) blinkCmd() tea.Cmd {
if m.cursorMode != CursorBlink {
return nil
}
if m.blinkCtx != nil && m.blinkCtx.cancel != nil {
m.blinkCtx.cancel()
}
ctx, cancel := context.WithTimeout(m.blinkCtx.ctx, m.BlinkSpeed)
m.blinkCtx.cancel = cancel
m.blinkTag++
return func() tea.Msg {
defer cancel()
<-ctx.Done()
if ctx.Err() == context.DeadlineExceeded {
return blinkMsg{id: m.id, tag: m.blinkTag}
}
return blinkCanceled{}
}
}
// Blink is a command used to initialize cursor blinking. // Blink is a command used to initialize cursor blinking.
func Blink() tea.Msg { func Blink() tea.Msg {
return initialBlinkMsg{} return cursor.Blink()
} }
// Paste is a command for pasting from the clipboard into the text input. // Paste is a command for pasting from the clipboard into the text input.
@@ -858,3 +659,31 @@ func max(a, b int) int {
} }
return b return b
} }
// Deprecated.
// Deprecated: use cursor.Mode.
type CursorMode int
const (
// Deprecated: use cursor.CursorBlink.
CursorBlink = CursorMode(cursor.CursorBlink)
// Deprecated: use cursor.CursorStatic.
CursorStatic = CursorMode(cursor.CursorStatic)
// Deprecated: use cursor.CursorHide.
CursorHide = CursorMode(cursor.CursorHide)
)
func (c CursorMode) String() string {
return cursor.Mode(c).String()
}
// Deprecated: use cursor.Mode().
func (m Model) CursorMode() CursorMode {
return CursorMode(m.Cursor.Mode())
}
// Deprecated: use cursor.SetMode().
func (m *Model) SetCursorMode(mode CursorMode) tea.Cmd {
return m.Cursor.SetMode(cursor.Mode(mode))
}