feat(viewport): line count getters (#283)

This reverts commit a4ed54327f.

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/build.yml

@@ -11,12 +11,12 @@ jobs:
       GO111MODULE: "on"
     steps:
       - name: Install Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go-version }}
 
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Download Go modules
         run: go mod download

.github/workflows/coverage.yml

@@ -12,12 +12,12 @@ jobs:
       GO111MODULE: "on"
     steps:
       - name: Install Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go-version }}
 
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Coverage
         env:

.github/workflows/lint-soft.yml

@@ -0,0 +1,28 @@
+name: lint-soft
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  pull-requests: read
+
+jobs:
+  golangci:
+    name: lint-soft
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ^1
+
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          # Optional: golangci-lint command line arguments.
+          args: --config .golangci-soft.yml --issues-exit-code=0
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          only-new-issues: true

.github/workflows/lint.yml

@@ -1,18 +1,28 @@
 name: lint
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  pull-requests: read
 
 jobs:
   golangci:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ^1
+
+      - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
           # Optional: golangci-lint command line arguments.
-          args: --issues-exit-code=0
+          #args:
-          # Optional: working directory, useful for monorepos
-          # working-directory: somedir
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           only-new-issues: true

.golangci-soft.yml

@@ -0,0 +1,47 @@
+run:
+  tests: false
+
+issues:
+  include:
+    - EXC0001
+    - EXC0005
+    - EXC0011
+    - EXC0012
+    - EXC0013
+
+  max-issues-per-linter: 0
+  max-same-issues: 0
+
+linters:
+  enable:
+    # - dupl
+    - exhaustive
+    # - exhaustivestruct
+    - goconst
+    - godot
+    - godox
+    - gomnd
+    - gomoddirectives
+    - goprintffuncname
+    - ifshort
+    # - lll
+    - misspell
+    - nakedret
+    - nestif
+    - noctx
+    - nolintlint
+    - prealloc
+    - wrapcheck
+
+  # disable default linters, they are already enabled in .golangci.yml
+  disable:
+    - deadcode
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unused
+    - varcheck

.golangci.yml

@@ -15,20 +15,15 @@ issues:
 linters:
   enable:
     - bodyclose
-    - dupl
     - exportloopref
-    - goconst
-    - godot
-    - godox
     - goimports
-    - goprintffuncname
     - gosec
-    - ifshort
+    - nilerr
-    - misspell
+    - predeclared
-    - prealloc
     - revive
     - rowserrcheck
     - sqlclosecheck
+    - tparallel
     - unconvert
     - unparam
     - whitespace

README.md

@@ -64,11 +64,7 @@ Supports vertical scrolling and many customization options.
 
 ## Progress
 
-<picture>
+<img src="https://stuff.charm.sh/bubbles-examples/progress.gif" width="800" alt="Progressbar Example">
-  <source media="(max-width: 800px)" srcset="https://stuff.charm.sh/bubbles-examples/progress.gif">
-  <source media="(min-width: 800px)" width="800" srcset="https://stuff.charm.sh/bubbles-examples/progress.gif">
-  <img src="https://stuff.charm.sh/bubbles-examples/progress.gif" alt="Progressbar Example">
-</picture>
 
 A simple, customizable progress meter, with optional animation via
 [Harmonica][harmonica]. Supports solid and gradient fills. The empty and filled
@@ -95,11 +91,7 @@ logic and visualize pagination however you like.
 
 ## Viewport
 
-<picture>
+<img src="https://stuff.charm.sh/bubbles-examples/viewport.gif" width="600" alt="Viewport Example">
-  <source media="(max-width: 600px)" srcset="https://stuff.charm.sh/bubbles-examples/viewport.gif?0">
-  <source media="(min-width: 600px)" width="600" srcset="https://stuff.charm.sh/bubbles-examples/viewport.gif?0">
-  <img src="https://stuff.charm.sh/bubbles-examples/viewport.gif?0" alt="Viewport Example">
-</picture>
 
 A viewport for vertically scrolling content. Optionally includes standard
 pager keybindings and mouse wheel support. A high performance mode is available
@@ -115,11 +107,7 @@ indenting and text wrapping.
 
 ## List
 
-<picture>
+<img src="https://stuff.charm.sh/bubbles-examples/list.gif" width="600" alt="List Example">
-  <source media="(max-width: 600px)" srcset="https://stuff.charm.sh/bubbles-examples/list.gif">
-  <source media="(min-width: 600px)" width="600" srcset="https://stuff.charm.sh/bubbles-examples/list.gif">
-  <img src="https://stuff.charm.sh/bubbles-examples/list.gif" alt="List Example">
-</picture>
 
 A customizable, batteries-included component for browsing a set of items.
 Features pagination, fuzzy filtering, auto-generated help, an activity spinner,
@@ -153,11 +141,7 @@ can be customized as you see fit.
 
 ## Help
 
-<picture>
+<img src="https://stuff.charm.sh/bubbles-examples/help.gif" width="500" alt="Help Example">
-  <source media="(max-width: 500px)" srcset="https://stuff.charm.sh/bubbles-examples/help.gif">
-  <source media="(min-width: 500px)" width="500" srcset="https://stuff.charm.sh/bubbles-examples/help.gif">
-  <img src="https://stuff.charm.sh/bubbles-examples/help.gif" alt="Help Example">
-</picture>
 
 A customizable horizontal mini help view that automatically generates itself
 from your keybindings. It features single and multi-line modes, which the user
@@ -233,12 +217,18 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 If you’ve built a Bubble you think should be listed here,
 [let us know](mailto:vt100@charm.sh).
 
+## Feedback
+
+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)
 
 ## License
 
 [MIT](https://github.com/charmbracelet/bubbletea/raw/master/LICENSE)
 
-
 ***
 
 Part of [Charm](https://charm.sh).
@@ -246,5 +236,3 @@ Part of [Charm](https://charm.sh).
 <a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>
 
 Charm热爱开源 • Charm loves open source
-
-[charm]: https://charm.sh/

go.mod

@@ -4,12 +4,12 @@ go 1.13
 
 require (
 	github.com/atotto/clipboard v0.1.4
-	github.com/charmbracelet/bubbletea v0.21.0
+	github.com/charmbracelet/bubbletea v0.22.1
 	github.com/charmbracelet/harmonica v0.2.0
-	github.com/charmbracelet/lipgloss v0.5.0
+	github.com/charmbracelet/lipgloss v0.6.0
 	github.com/kylelemons/godebug v1.1.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0
-	github.com/mattn/go-runewidth v0.0.13
+	github.com/mattn/go-runewidth v0.0.14
 	github.com/muesli/reflow v0.3.0
 	github.com/muesli/termenv v0.11.1-0.20220212125758-44cd13922739
 	github.com/sahilm/fuzzy v0.1.0

go.sum

@@ -1,27 +1,31 @@
 github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
 github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
-github.com/charmbracelet/bubbletea v0.21.0 h1:f3y+kanzgev5PA916qxmDybSHU3N804uOnKnhRPXTcI=
+github.com/charmbracelet/bubbletea v0.22.1 h1:z66q0LWdJNOWEH9zadiAIXp2GN1AWrwNXU8obVY9X24=
-github.com/charmbracelet/bubbletea v0.21.0/go.mod h1:GgmJMec61d08zXsOhqRC/AiOx4K4pmz+VIcRIm1FKr4=
+github.com/charmbracelet/bubbletea v0.22.1/go.mod h1:8/7hVvbPN6ZZPkczLiB8YpLkLJ0n7DMho5Wvfd2X1C0=
 github.com/charmbracelet/harmonica v0.2.0 h1:8NxJWRWg/bzKqqEaaeFNipOu77YR5t8aSwG4pgaUBiQ=
 github.com/charmbracelet/harmonica v0.2.0/go.mod h1:KSri/1RMQOZLbw7AHqgcBycp8pgJnQMYYT8QZRqZ1Ao=
-github.com/charmbracelet/lipgloss v0.5.0 h1:lulQHuVeodSgDez+3rGiuxlPVXSnhth442DATR2/8t8=
+github.com/charmbracelet/lipgloss v0.6.0 h1:1StyZB9vBSOyuZxQUcUwGr17JmojPNm87inij9N3wJY=
-github.com/charmbracelet/lipgloss v0.5.0/go.mod h1:EZLha/HbzEt7cYqdFPovlqy5FZPj0xFhg5SaqxScmgs=
+github.com/charmbracelet/lipgloss v0.6.0/go.mod h1:tHh2wr34xcHjC2HCXIlGSG1jaDF0S0atAUvBMP6Ppuk=
 github.com/containerd/console v1.0.3 h1:lIr7SlA5PxZyMV30bDW0MGbiOPXwc63yRuCP0ARubLw=
 github.com/containerd/console v1.0.3/go.mod h1:7LqA/THxQ86k76b8c/EMSiaJ3h1eZkMkXar0TQ1gf3U=
 github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
-github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
 github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
+github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
+github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
 github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
 github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
-github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU=
 github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/mattn/go-runewidth v0.0.14 h1:+xnbZSEeDbOIg5/mE6JF0w6n9duR1l3/WmbinWVwUuU=
+github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b h1:1XF24mVaiu7u+CFywTdcDo2ie1pzzhwjt6RHqzpMU34=
 github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b/go.mod h1:fQuZ0gauxyBcmsdE3ZT4NasjaRdxmbCS0jRHsrWu3Ho=
-github.com/muesli/cancelreader v0.2.0 h1:SOpr+CfyVNce341kKqvbhhzQhBPyJRXQaCtn03Pae1Q=
+github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
-github.com/muesli/cancelreader v0.2.0/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
+github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
 github.com/muesli/reflow v0.2.1-0.20210115123740-9e1d0d53df68/go.mod h1:Xk+z4oIWdQqJzsxyjgl3P22oYZnHdZ8FFTHAQQt5BMQ=
 github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s=
 github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8=
@@ -29,10 +33,7 @@ github.com/muesli/termenv v0.11.1-0.20220204035834-5ac8409525e0/go.mod h1:Bd5NYQ
 github.com/muesli/termenv v0.11.1-0.20220212125758-44cd13922739 h1:QANkGiGr39l1EESqrE0gZw0/AJNYzIvoGLhIoVYtluI=
 github.com/muesli/termenv v0.11.1-0.20220212125758-44cd13922739/go.mod h1:Bd5NYQ7pd+SrtBSrSNoBBmXlcY8+Xj4BMJgh8qcZrvs=
 github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
-github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
-github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
-github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/sahilm/fuzzy v0.1.0 h1:FzWGaw2Opqyu+794ZQ9SYifWv2EIXpwP4q8dY1kDAwI=
 github.com/sahilm/fuzzy v0.1.0/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y=
@@ -40,7 +41,10 @@ golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220204135822-1c1b9b1eba6a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220209214540-3681064d5158 h1:rm+CHSpPEEW2IsXUib1ThaHIjuBVZjxNgSKmBLFfD4c=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab h1:2QkjZIsXupsJbJIdSjjUOgWK3aEtzyuh2mPt3l/CkeU=
-golang.org/x/sys v0.0.0-20220209214540-3681064d5158/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

help/help.go

@@ -203,7 +203,7 @@ func (m Model) FullHelpView(groups [][]key.Binding) string {
 
 		// Column
 		totalWidth += lipgloss.Width(col)
-		if totalWidth > m.Width {
+		if m.Width > 0 && totalWidth > m.Width {
 			break
 		}
 
@@ -212,7 +212,7 @@ func (m Model) FullHelpView(groups [][]key.Binding) string {
 		// Separator
 		if i < len(group)-1 {
 			totalWidth += sepWidth
-			if totalWidth > m.Width {
+			if m.Width > 0 && totalWidth > m.Width {
 				break
 			}
 		}

key/key.go

@@ -2,35 +2,35 @@
 // keymappings useful in Bubble Tea components. There are a few different ways
 // you can define a keymapping with this package. Here's one example:
 //
-//     type KeyMap struct {
+//	type KeyMap struct {
-//         Up key.Binding
+//	    Up key.Binding
-//         Down key.Binding
+//	    Down key.Binding
-//     }
+//	}
 //
-//     var DefaultKeyMap = KeyMap{
+//	var DefaultKeyMap = KeyMap{
-//         Up: key.NewBinding(
+//	    Up: key.NewBinding(
-//             key.WithKeys("k", "up"),        // actual keybindings
+//	        key.WithKeys("k", "up"),        // actual keybindings
-//             key.WithHelp("↑/k", "move up"), // corresponding help text
+//	        key.WithHelp("↑/k", "move up"), // corresponding help text
-//         ),
+//	    ),
-//         Down: key.NewBinding(
+//	    Down: key.NewBinding(
-//             key.WithKeys("j", "down"),
+//	        key.WithKeys("j", "down"),
-//             key.WithHelp("↓/j", "move down"),
+//	        key.WithHelp("↓/j", "move down"),
-//         ),
+//	    ),
-//     }
+//	}
 //
-//     func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+//	func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
-//         switch msg := msg.(type) {
+//	    switch msg := msg.(type) {
-//         case tea.KeyMsg:
+//	    case tea.KeyMsg:
-//             switch {
+//	        switch {
-//             case key.Matches(msg, DefaultKeyMap.Up):
+//	        case key.Matches(msg, DefaultKeyMap.Up):
-//                 // The user pressed up
+//	            // The user pressed up
-//             case key.Matches(msg, DefaultKeyMap.Down):
+//	        case key.Matches(msg, DefaultKeyMap.Down):
-//                 // The user pressed down
+//	            // The user pressed down
-//             }
+//	        }
-//         }
+//	    }
 //
-//         // ...
+//	    // ...
-//     }
+//	}
 //
 // The help information, which is not used in the example above, can be used
 // to render help text for keystrokes in your views.

list/list.go

@@ -183,18 +183,18 @@ type Model struct {
 func New(items []Item, delegate ItemDelegate, width, height int) Model {
 	styles := DefaultStyles()
 
-	sp := spinner.NewModel()
+	sp := spinner.New()
 	sp.Spinner = spinner.Line
 	sp.Style = styles.Spinner
 
-	filterInput := textinput.NewModel()
+	filterInput := textinput.New()
 	filterInput.Prompt = "Filter: "
 	filterInput.PromptStyle = styles.FilterPrompt
 	filterInput.CursorStyle = styles.FilterCursor
 	filterInput.CharLimit = 64
 	filterInput.Focus()
 
-	p := paginator.NewModel()
+	p := paginator.New()
 	p.Type = paginator.Dots
 	p.ActiveDot = styles.ActivePaginationDot.String()
 	p.InactiveDot = styles.InactivePaginationDot.String()
@@ -221,7 +221,7 @@ func New(items []Item, delegate ItemDelegate, width, height int) Model {
 		items:     items,
 		Paginator: p,
 		spinner:   sp,
-		Help:      help.NewModel(),
+		Help:      help.New(),
 	}
 
 	m.updatePagination()
@@ -526,7 +526,7 @@ func (m Model) FilterValue() string {
 // SettingFilter returns whether or not the user is currently editing the
 // filter value. It's purely a convenience method for the following:
 //
-//     m.FilterState() == Filtering
+//	m.FilterState() == Filtering
 //
 // It's included here because it's a common thing to check for when
 // implementing this component.
@@ -537,8 +537,7 @@ func (m Model) SettingFilter() bool {
 // IsFiltered returns whether or not the list is currently filtered.
 // It's purely a convenience method for the following:
 //
-//	 m.FilterState() == FilterApplied
+//	m.FilterState() == FilterApplied
-//
 func (m Model) IsFiltered() bool {
 	return m.filterState == FilterApplied
 }

paginator/paginator.go

@@ -7,6 +7,7 @@ package paginator
 import (
 	"fmt"
 
+	"github.com/charmbracelet/bubbles/key"
 	tea "github.com/charmbracelet/bubbletea"
 )
 
@@ -19,20 +20,49 @@ const (
 	Dots
 )
 
+// KeyMap is the key bindings for different actions within the paginator.
+type KeyMap struct {
+	PrevPage key.Binding
+	NextPage key.Binding
+}
+
+// DefaultKeyMap is the default set of key bindings for navigating and acting
+// upon the paginator.
+var DefaultKeyMap = KeyMap{
+	PrevPage: key.NewBinding(key.WithKeys("pgup", "left", "h")),
+	NextPage: key.NewBinding(key.WithKeys("pgdown", "right", "l")),
+}
+
 // Model is the Bubble Tea model for this user interface.
 type Model struct {
-	Type              Type
+	// Type configures how the pagination is rendered (Arabic, Dots).
-	Page              int
+	Type Type
-	PerPage           int
+	// Page is the current page number.
-	TotalPages        int
+	Page int
-	ActiveDot         string
+	// PerPage is the number of items per page.
-	InactiveDot       string
+	PerPage int
-	ArabicFormat      string
+	// TotalPages is the total number of pages.
+	TotalPages int
+	// ActiveDot is used to mark the current page under the Dots display type.
+	ActiveDot string
+	// InactiveDot is used to mark inactive pages under the Dots display type.
+	InactiveDot string
+	// ArabicFormat is the printf-style format to use for the Arabic display type.
+	ArabicFormat string
+
+	// KeyMap encodes the keybindings recognized by the widget.
+	KeyMap KeyMap
+
+	// Deprecated: customize KeyMap instead.
 	UsePgUpPgDownKeys bool
-	UseLeftRightKeys  bool
+	// Deprecated: customize KeyMap instead.
-	UseUpDownKeys     bool
+	UseLeftRightKeys bool
-	UseHLKeys         bool
+	// Deprecated: customize KeyMap instead.
-	UseJKKeys         bool
+	UseUpDownKeys bool
+	// Deprecated: customize KeyMap instead.
+	UseHLKeys bool
+	// Deprecated: customize KeyMap instead.
+	UseJKKeys bool
 }
 
 // SetTotalPages is a helper function for calculating the total number of pages
@@ -65,10 +95,9 @@ func (m Model) ItemsOnPage(totalItems int) int {
 // of the slice you're rendering and you'll receive the start and end bounds
 // corresponding the to pagination. For example:
 //
-//     bunchOfStuff := []stuff{...}
+//	bunchOfStuff := []stuff{...}
-//     start, end := model.GetSliceBounds(len(bunchOfStuff))
+//	start, end := model.GetSliceBounds(len(bunchOfStuff))
-//     sliceToRender := bunchOfStuff[start:end]
+//	sliceToRender := bunchOfStuff[start:end]
-//
 func (m *Model) GetSliceBounds(length int) (start int, end int) {
 	start = m.Page * m.PerPage
 	end = min(m.Page*m.PerPage+m.PerPage, length)
@@ -99,18 +128,14 @@ func (m Model) OnLastPage() bool {
 // New creates a new model with defaults.
 func New() Model {
 	return Model{
-		Type:              Arabic,
+		Type:         Arabic,
-		Page:              0,
+		Page:         0,
-		PerPage:           1,
+		PerPage:      1,
-		TotalPages:        1,
+		TotalPages:   1,
-		ActiveDot:         "•",
+		KeyMap:       DefaultKeyMap,
-		InactiveDot:       "○",
+		ActiveDot:    "•",
-		ArabicFormat:      "%d/%d",
+		InactiveDot:  "○",
-		UsePgUpPgDownKeys: true,
+		ArabicFormat: "%d/%d",
-		UseLeftRightKeys:  true,
-		UseUpDownKeys:     false,
-		UseHLKeys:         true,
-		UseJKKeys:         false,
 	}
 }
 
@@ -123,45 +148,11 @@ var NewModel = New
 func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyMsg:
-		if m.UsePgUpPgDownKeys {
+		switch {
-			switch msg.String() {
+		case key.Matches(msg, m.KeyMap.NextPage):
-			case "pgup":
+			m.NextPage()
-				m.PrevPage()
+		case key.Matches(msg, m.KeyMap.PrevPage):
-			case "pgdown":
+			m.PrevPage()
-				m.NextPage()
-			}
-		}
-		if m.UseLeftRightKeys {
-			switch msg.String() {
-			case "left":
-				m.PrevPage()
-			case "right":
-				m.NextPage()
-			}
-		}
-		if m.UseUpDownKeys {
-			switch msg.String() {
-			case "up":
-				m.PrevPage()
-			case "down":
-				m.NextPage()
-			}
-		}
-		if m.UseHLKeys {
-			switch msg.String() {
-			case "h":
-				m.PrevPage()
-			case "l":
-				m.NextPage()
-			}
-		}
-		if m.UseJKKeys {
-			switch msg.String() {
-			case "j":
-				m.PrevPage()
-			case "k":
-				m.NextPage()
-			}
 		}
 	}
 

progress/progress.go

@@ -37,13 +37,12 @@ const (
 	defaultDamping   = 1.0
 )
 
-// Option is used to set options in NewModel. For example:
+// Option is used to set options in New. For example:
-//
-//     progress := NewModel(
-//	       WithRamp("#ff0000", "#0000ff"),
-//	       WithoutPercentage(),
-//     )
 //
+//	    progress := New(
+//		       WithRamp("#ff0000", "#0000ff"),
+//		       WithoutPercentage(),
+//	    )
 type Option func(*Model)
 
 // WithDefaultGradient sets a gradient fill with default colors.

spinner/spinner.go

@@ -85,7 +85,7 @@ var (
 	}
 )
 
-// Model contains the state for the spinner. Use NewModel to create new models
+// Model contains the state for the spinner. Use New to create new models
 // rather than using Model as a struct literal.
 type Model struct {
 	// Spinner settings to use. See type Spinner.
@@ -208,8 +208,7 @@ func Tick() tea.Msg {
 
 // Option is used to set options in New. For example:
 //
-//    spinner := New(WithSpinner(Dot))
+//	spinner := New(WithSpinner(Dot))
-//
 type Option func(*Model)
 
 // WithSpinner is an option to set the spinner.

table/table.go

@@ -109,8 +109,7 @@ func (m *Model) SetStyles(s Styles) {
 
 // Option is used to set options in New. For example:
 //
-//    table := New(WithColumns([]Column{{Title: "ID", Width: 10}}))
+//	table := New(WithColumns([]Column{{Title: "ID", Width: 10}}))
-//
 type Option func(*Model)
 
 // New creates a new model for the table widget.

textarea/textarea.go

@@ -6,7 +6,7 @@ import (
 	"unicode"
 
 	"github.com/atotto/clipboard"
-	"github.com/charmbracelet/bubbles/internal/cursor"
+	"github.com/charmbracelet/bubbles/cursor"
 	"github.com/charmbracelet/bubbles/key"
 	"github.com/charmbracelet/bubbles/viewport"
 	tea "github.com/charmbracelet/bubbletea"
@@ -494,6 +494,10 @@ func (m *Model) handlePaste(v string) {
 		}
 	}
 
+	// Put it all back together
+	value := append(head, tail...)
+	m.SetValue(string(value))
+
 	// Reset blink state if necessary and run overflow checks
 	m.SetCursor(m.col + len(paste))
 }

textinput/textinput.go

@@ -6,7 +6,8 @@ import (
 	"unicode"
 
 	"github.com/atotto/clipboard"
-	"github.com/charmbracelet/bubbles/internal/cursor"
+	"github.com/charmbracelet/bubbles/cursor"
+	"github.com/charmbracelet/bubbles/key"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"
 	rw "github.com/mattn/go-runewidth"
@@ -37,6 +38,41 @@ const (
 // ValidateFunc is a function that returns an error if the input is invalid.
 type ValidateFunc func(string) error
 
+// KeyMap is the key bindings for different actions within the textinput.
+type KeyMap struct {
+	CharacterForward        key.Binding
+	CharacterBackward       key.Binding
+	WordForward             key.Binding
+	WordBackward            key.Binding
+	DeleteWordBackward      key.Binding
+	DeleteWordForward       key.Binding
+	DeleteAfterCursor       key.Binding
+	DeleteBeforeCursor      key.Binding
+	DeleteCharacterBackward key.Binding
+	DeleteCharacterForward  key.Binding
+	LineStart               key.Binding
+	LineEnd                 key.Binding
+	Paste                   key.Binding
+}
+
+// DefaultKeyMap is the default set of key bindings for navigating and acting
+// upon the textinput.
+var DefaultKeyMap = KeyMap{
+	CharacterForward:        key.NewBinding(key.WithKeys("right", "ctrl+f")),
+	CharacterBackward:       key.NewBinding(key.WithKeys("left", "ctrl+b")),
+	WordForward:             key.NewBinding(key.WithKeys("alt+right", "alt+f")),
+	WordBackward:            key.NewBinding(key.WithKeys("alt+left", "alt+b")),
+	DeleteWordBackward:      key.NewBinding(key.WithKeys("alt+backspace", "ctrl+w")),
+	DeleteWordForward:       key.NewBinding(key.WithKeys("alte+delete", "alt+d")),
+	DeleteAfterCursor:       key.NewBinding(key.WithKeys("ctrl+k")),
+	DeleteBeforeCursor:      key.NewBinding(key.WithKeys("ctrl+u")),
+	DeleteCharacterBackward: key.NewBinding(key.WithKeys("backspace", "ctrl+h")),
+	DeleteCharacterForward:  key.NewBinding(key.WithKeys("delete", "ctrl+d")),
+	LineStart:               key.NewBinding(key.WithKeys("home", "ctrl+a")),
+	LineEnd:                 key.NewBinding(key.WithKeys("end", "ctrl+e")),
+	Paste:                   key.NewBinding(key.WithKeys("ctrl+v")),
+}
+
 // Model is the Bubble Tea model for this text input element.
 type Model struct {
 	Err error
@@ -71,6 +107,9 @@ type Model struct {
 	// viewport. If 0 or less this setting is ignored.
 	Width int
 
+	// KeyMap encodes the keybindings recognized by the widget.
+	KeyMap KeyMap
+
 	// Underlying text value.
 	value []rune
 
@@ -101,6 +140,7 @@ func New() Model {
 		CharLimit:        0,
 		PlaceholderStyle: lipgloss.NewStyle().Foreground(lipgloss.Color("240")),
 		Cursor:           cursor.New(),
+		KeyMap:           DefaultKeyMap,
 
 		value: nil,
 		focus: false,
@@ -122,6 +162,7 @@ func (m *Model) SetValue(s string) {
 		}
 	}
 
+	empty := len(m.value) == 0
 	m.Err = nil
 
 	runes := []rune(s)
@@ -130,7 +171,7 @@ func (m *Model) SetValue(s string) {
 	} else {
 		m.value = runes
 	}
-	if m.pos > len(m.value) {
+	if (m.pos == 0 && empty) || m.pos > len(m.value) {
 		m.SetCursor(len(m.value))
 	}
 	m.handleOverflow()
@@ -169,7 +210,7 @@ func (m Model) Focused() bool {
 }
 
 // Focus sets the focus state on the model. When the model is in focus it can
-// receive keyboard input and the cursor will be hidden.
+// receive keyboard input and the cursor will be shown.
 func (m *Model) Focus() tea.Cmd {
 	m.focus = true
 	return m.Cursor.Focus()
@@ -299,8 +340,8 @@ func (m *Model) deleteAfterCursor() {
 	m.SetCursor(len(m.value))
 }
 
-// deleteWordLeft deletes the word left to the cursor.
+// deleteWordBackward deletes the word left to the cursor.
-func (m *Model) deleteWordLeft() {
+func (m *Model) deleteWordBackward() {
 	if m.pos == 0 || len(m.value) == 0 {
 		return
 	}
@@ -343,10 +384,10 @@ func (m *Model) deleteWordLeft() {
 	}
 }
 
-// deleteWordRight deletes the word right to the cursor If input is masked
+// deleteWordForward deletes the word right to the cursor If input is masked
 // delete everything after the cursor so as not to reveal word breaks in the
 // masked input.
-func (m *Model) deleteWordRight() {
+func (m *Model) deleteWordForward() {
 	if m.pos >= len(m.value) || len(m.value) == 0 {
 		return
 	}
@@ -384,9 +425,9 @@ func (m *Model) deleteWordRight() {
 	m.SetCursor(oldPos)
 }
 
-// wordLeft moves the cursor one word to the left. If input is masked, move
+// wordBackward moves the cursor one word to the left. If input is masked, move
 // input to the start so as not to reveal word breaks in the masked input.
-func (m *Model) wordLeft() {
+func (m *Model) wordBackward() {
 	if m.pos == 0 || len(m.value) == 0 {
 		return
 	}
@@ -416,9 +457,9 @@ func (m *Model) wordLeft() {
 	}
 }
 
-// wordRight moves the cursor one word to the right. If the input is masked,
+// wordForward moves the cursor one word to the right. If the input is masked,
 // move input to the end so as not to reveal word breaks in the masked input.
-func (m *Model) wordRight() {
+func (m *Model) wordForward() {
 	if m.pos >= len(m.value) || len(m.value) == 0 {
 		return
 	}
@@ -472,68 +513,49 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 
 	switch msg := msg.(type) {
 	case tea.KeyMsg:
-		switch msg.Type {
+		switch {
-		case tea.KeyBackspace, tea.KeyCtrlH: // delete character before cursor
+		case key.Matches(msg, m.KeyMap.DeleteWordBackward):
 			m.Err = nil
-
+			m.deleteWordBackward()
-			if msg.Alt {
+		case key.Matches(msg, m.KeyMap.DeleteCharacterBackward):
-				m.deleteWordLeft()
+			m.Err = nil
-			} 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 {
+					m.SetCursor(m.pos - 1)
-						m.SetCursor(m.pos - 1)
-					}
 				}
 			}
-		case tea.KeyLeft, tea.KeyCtrlB:
+		case key.Matches(msg, m.KeyMap.WordBackward):
-			if msg.Alt { // alt+left arrow, back one word
+			m.wordBackward()
-				m.wordLeft()
+		case key.Matches(msg, m.KeyMap.CharacterBackward):
-				break
+			if m.pos > 0 {
-			}
-			if m.pos > 0 { // left arrow, ^F, back one character
 				m.SetCursor(m.pos - 1)
 			}
-		case tea.KeyRight, tea.KeyCtrlF:
+		case key.Matches(msg, m.KeyMap.WordForward):
-			if msg.Alt { // alt+right arrow, forward one word
+			m.wordForward()
-				m.wordRight()
+		case key.Matches(msg, m.KeyMap.CharacterForward):
-				break
+			if m.pos < len(m.value) {
-			}
-			if m.pos < len(m.value) { // right arrow, ^F, forward one character
 				m.SetCursor(m.pos + 1)
 			}
-		case tea.KeyCtrlW: // ^W, delete word left of cursor
+		case key.Matches(msg, m.KeyMap.DeleteWordBackward):
-			m.deleteWordLeft()
+			m.deleteWordBackward()
-		case tea.KeyHome, tea.KeyCtrlA: // ^A, go to beginning
+		case key.Matches(msg, m.KeyMap.LineStart):
 			m.CursorStart()
-		case tea.KeyDelete, tea.KeyCtrlD: // ^D, delete char under cursor
+		case key.Matches(msg, m.KeyMap.DeleteCharacterForward):
 			if len(m.value) > 0 && m.pos < len(m.value) {
 				m.value = append(m.value[:m.pos], m.value[m.pos+1:]...)
 			}
-		case tea.KeyCtrlE, tea.KeyEnd: // ^E, go to end
+		case key.Matches(msg, m.KeyMap.LineEnd):
 			m.CursorEnd()
-		case tea.KeyCtrlK: // ^K, kill text after cursor
+		case key.Matches(msg, m.KeyMap.DeleteAfterCursor):
 			m.deleteAfterCursor()
-		case tea.KeyCtrlU: // ^U, kill text before cursor
+		case key.Matches(msg, m.KeyMap.DeleteBeforeCursor):
 			m.deleteBeforeCursor()
-		case tea.KeyCtrlV: // ^V paste
+		case key.Matches(msg, m.KeyMap.Paste):
 			return m, Paste
-		case tea.KeyRunes, tea.KeySpace: // input regular characters
+		case key.Matches(msg, m.KeyMap.DeleteWordForward):
-			if msg.Alt && len(msg.Runes) == 1 {
+			m.deleteWordForward()
-				if msg.Runes[0] == 'd' { // alt+d, delete word right of cursor
+		default:
-					m.deleteWordRight()
-					break
-				}
-				if msg.Runes[0] == 'b' { // alt+b, back one word
-					m.wordLeft()
-					break
-				}
-				if msg.Runes[0] == 'f' { // alt+f, forward one word
-					m.wordRight()
-					break
-				}
-			}
-
 			// Input a regular character
 			if m.CharLimit <= 0 || len(m.value) < m.CharLimit {
 				runes := msg.Runes

viewport/viewport.go

@@ -207,6 +207,16 @@ func (m *Model) LineUp(n int) (lines []string) {
 	return m.visibleLines()
 }
 
+// TotalLineCount returns the total number of lines (both hidden and visible) within the viewport.
+func (m Model) TotalLineCount() int {
+	return len(m.lines)
+}
+
+// VisibleLineCount returns the number of the visible lines within the viewport.
+func (m Model) VisibleLineCount() int {
+	return len(m.visibleLines())
+}
+
 // GotoTop sets the viewport to the top position.
 func (m *Model) GotoTop() (lines []string) {
 	if m.AtTop() {
@@ -240,9 +250,8 @@ func Sync(m Model) tea.Cmd {
 // number of lines. Use Model.ViewDown to get the lines that should be rendered.
 // For example:
 //
-//     lines := model.ViewDown(1)
+//	lines := model.ViewDown(1)
-//     cmd := ViewDown(m, lines)
+//	cmd := ViewDown(m, lines)
-//
 func ViewDown(m Model, lines []string) tea.Cmd {
 	if len(lines) == 0 {
 		return nil