mirror of
https://github.com/Maks1mS/bubbles.git
synced 2025-10-18 16:38:56 +03:00
Compare commits
74 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
bdd909a5d7 | ||
|
b08b3efa02 | ||
|
83b6a2205f | ||
|
c06af8962d | ||
|
3a65be950a | ||
|
2dd6e0c80b | ||
|
1e50e6d291 | ||
|
573f90a876 | ||
|
a498b857d6 | ||
|
82097a1c79 | ||
|
a8ec421800 | ||
|
9c10cd0586 | ||
|
154f3763f7 | ||
|
eff931bdea | ||
|
0d7b3ed8e8 | ||
|
cbafae84f9 | ||
|
959598c9aa | ||
|
5f7c8b5375 | ||
|
75df6b96a1 | ||
|
084d0acefd | ||
|
e8526ec4ef | ||
|
68f11d0b63 | ||
|
f78a02cc29 | ||
|
9a4fbb3be1 | ||
|
d4a0ecd3ee | ||
|
34b1f47068 | ||
|
dbd40713ce | ||
|
54a0d84255 | ||
|
004511e00f | ||
|
7fa53ea961 | ||
|
0cc5e71a63 | ||
|
f11ca377f4 | ||
|
10022c964c | ||
|
5357dd61bd | ||
|
5a26cb0d8e | ||
|
88469a499e | ||
|
b130d96434 | ||
|
185a19e56f | ||
|
dbb1d93970 | ||
|
2f909886c1 | ||
|
5720cfb35a | ||
|
3c07b97d37 | ||
|
9b3e5476c3 | ||
|
74e84eca55 | ||
|
ccf4c90b6b | ||
|
f341e3c896 | ||
|
c9196e5407 | ||
|
f967f6a87f | ||
|
35c3cd626d | ||
|
2525319d72 | ||
|
e9dd6b06e0 | ||
|
7cef3a6f59 | ||
|
1cdc2045c7 | ||
|
cc480dd2f3 | ||
|
0c1781fbb3 | ||
|
5255143e87 | ||
|
1629afe087 | ||
|
da3150ded7 | ||
|
b82cf5071d | ||
|
d095a6554c | ||
|
34ac608122 | ||
|
09ae5da7c3 | ||
|
5572542e2e | ||
|
3688351ddf | ||
|
d9c03fc0b0 | ||
|
3321ac12a9 | ||
|
0eaea5cc5d | ||
|
0243dff9d3 | ||
|
68ec6c7ffc | ||
|
f332bf2cc2 | ||
|
0b19d41e0a | ||
|
786ec557d4 | ||
|
d3192a3e70 | ||
|
74cc86fce5 |
37
.github/workflows/build.yml
vendored
Normal file
37
.github/workflows/build.yml
vendored
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
name: build
|
||||||
|
on: [push, pull_request]
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
go-version: [1.13.x, 1.14.x, 1.15.x]
|
||||||
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
env:
|
||||||
|
GO111MODULE: "on"
|
||||||
|
steps:
|
||||||
|
- name: Install Go
|
||||||
|
uses: actions/setup-go@v1
|
||||||
|
with:
|
||||||
|
go-version: ${{ matrix.go-version }}
|
||||||
|
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Download Go modules
|
||||||
|
run: go mod download
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: go build -v ./...
|
||||||
|
|
||||||
|
- name: Test
|
||||||
|
run: go test ./...
|
||||||
|
|
||||||
|
- name: Coverage
|
||||||
|
env:
|
||||||
|
COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run: |
|
||||||
|
go test -race -covermode atomic -coverprofile=profile.cov ./...
|
||||||
|
GO111MODULE=off go get github.com/mattn/goveralls
|
||||||
|
$(go env GOPATH)/bin/goveralls -coverprofile=profile.cov -service=github
|
||||||
|
if: matrix.go-version == '1.15.x' && matrix.os == 'ubuntu-latest'
|
20
.github/workflows/lint.yml
vendored
Normal file
20
.github/workflows/lint.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
name: lint
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
golangci:
|
||||||
|
name: lint
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: golangci-lint
|
||||||
|
uses: golangci/golangci-lint-action@v2
|
||||||
|
with:
|
||||||
|
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
|
||||||
|
version: v1.30
|
||||||
|
# Optional: golangci-lint command line arguments.
|
||||||
|
args: --issues-exit-code=0
|
||||||
|
# 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
|
26
.golangci.yml
Normal file
26
.golangci.yml
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
run:
|
||||||
|
tests: false
|
||||||
|
|
||||||
|
issues:
|
||||||
|
max-issues-per-linter: 0
|
||||||
|
max-same-issues: 0
|
||||||
|
|
||||||
|
linters:
|
||||||
|
enable:
|
||||||
|
- bodyclose
|
||||||
|
- dupl
|
||||||
|
- exportloopref
|
||||||
|
- goconst
|
||||||
|
- godot
|
||||||
|
- godox
|
||||||
|
- goimports
|
||||||
|
- gomnd
|
||||||
|
- goprintffuncname
|
||||||
|
- gosec
|
||||||
|
- misspell
|
||||||
|
- prealloc
|
||||||
|
- rowserrcheck
|
||||||
|
- sqlclosecheck
|
||||||
|
- unconvert
|
||||||
|
- unparam
|
||||||
|
- whitespace
|
76
README.md
76
README.md
@@ -1,9 +1,79 @@
|
|||||||
# Tea Party
|
Bubbles
|
||||||
|
=======
|
||||||
|
|
||||||
Components for [Tea](https://github.com/charmbraclet/tea)
|
[](https://github.com/charmbracelet/bubbles/actions)
|
||||||
|
[](http://goreportcard.com/report/charmbracelet/bubbles)
|
||||||
|
[](https://pkg.go.dev/github.com/charmbracelet/bubbles)
|
||||||
|
|
||||||
|
Some components for [Bubble Tea](https://github.com/charmbracelet/bubbletea) applications.
|
||||||
|
|
||||||
|
These components are used in production in [Glow][glow] and [Charm][charm].
|
||||||
|
|
||||||
|
[glow]: https://github.com/charmbracelet/glow
|
||||||
|
[charm]: https://github.com/charmbracelet/charm
|
||||||
|
|
||||||
|
|
||||||
|
## 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](https://github.com/charmbracelet/tea/tree/master/examples/spinner/main.go)
|
||||||
|
|
||||||
|
|
||||||
|
## Text Input
|
||||||
|
|
||||||
|
<img src="https://stuff.charm.sh/bubbles-examples/textinput.gif" width="400" alt="Text Input Example">
|
||||||
|
|
||||||
|
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/tea/tree/master/examples/textinput/main.go)
|
||||||
|
* [Example code, many fields](https://github.com/charmbracelet/tea/tree/master/examples/textinput/main.go)
|
||||||
|
|
||||||
|
|
||||||
|
## Paginator
|
||||||
|
|
||||||
|
<img src="https://stuff.charm.sh/bubbles-examples/pagination.gif" width="200" alt="Paginator Example">
|
||||||
|
|
||||||
|
A component for handling pagination logic and optionally drawing pagination UI.
|
||||||
|
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.
|
||||||
|
|
||||||
|
This component is used in [Glow][glow] to browse documents and [Charm][charm] to
|
||||||
|
browse SSH keys.
|
||||||
|
|
||||||
|
|
||||||
|
## Viewport
|
||||||
|
|
||||||
|
<img src="https://stuff.charm.sh/bubbles-examples/viewport.gif" width="600" alt="Viewport Example">
|
||||||
|
|
||||||
|
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 alterate screen buffer.
|
||||||
|
|
||||||
|
* [Example code](https://github.com/charmbracelet/tea/tree/master/examples/pager/main.go)
|
||||||
|
|
||||||
|
This component is well complimented with [Reflow][reflow] for ANSI-aware
|
||||||
|
indenting and text wrapping.
|
||||||
|
|
||||||
|
[reflow]: https://github.com/muesli/reflow
|
||||||
|
|
||||||
⚠️ This project is a pre-release! Check back later.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT](https://github.com/charmbracelet/teaparty/raw/master/LICENSE)
|
[MIT](https://github.com/charmbracelet/teaparty/raw/master/LICENSE)
|
||||||
|
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
10
go.mod
10
go.mod
@@ -3,8 +3,10 @@ module github.com/charmbracelet/bubbles
|
|||||||
go 1.13
|
go 1.13
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/charmbracelet/bubbletea v0.8.0
|
github.com/atotto/clipboard v0.1.2
|
||||||
github.com/muesli/termenv v0.5.3-0.20200526053627-d728968dcf83
|
github.com/charmbracelet/bubbletea v0.12.1
|
||||||
golang.org/x/crypto v0.0.0-20200604202706-70a84ac30bf9 // indirect
|
github.com/mattn/go-runewidth v0.0.9
|
||||||
golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980 // indirect
|
github.com/muesli/termenv v0.7.4
|
||||||
|
golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897 // indirect
|
||||||
|
golang.org/x/sys v0.0.0-20201020230747-6e5568b54d1a // indirect
|
||||||
)
|
)
|
||||||
|
37
go.sum
37
go.sum
@@ -1,26 +1,35 @@
|
|||||||
github.com/charmbracelet/bubbletea v0.8.0 h1:ruZFaFF+2kgCI1IwNG40KTYDW5ZvE2+hPy4odlBdUko=
|
github.com/atotto/clipboard v0.1.2 h1:YZCtFu5Ie8qX2VmVTBnrqLSiU9XOWwqNRmdT3gIQzbY=
|
||||||
github.com/charmbracelet/bubbletea v0.8.0/go.mod h1:DzNhKkQQJI30eb+kBcaOs1+z86zTSqcMgSHoFY+uCsg=
|
github.com/atotto/clipboard v0.1.2/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
|
||||||
|
github.com/charmbracelet/bubbletea v0.12.1 h1:t21pkG2IDBRduPbt2J64Dx5yt8yIidAkXwhhrc11SzY=
|
||||||
|
github.com/charmbracelet/bubbletea v0.12.1/go.mod h1:3gZkYELUOiEUOp0bTInkxguucy/xRbGSOcbMs1geLxg=
|
||||||
|
github.com/containerd/console v1.0.1 h1:u7SFAJyRqWcG6ogaMAx3KjSTy1e3hT9QxqX7Jco7dRc=
|
||||||
|
github.com/containerd/console v1.0.1/go.mod h1:XUsP6YE/mKtz6bxc+I8UiKKTP04qjQL4qcS3XoQ5xkw=
|
||||||
github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f h1:5CjVwnuUcp5adK4gmY6i72gpVFVnZDP2h5TmPScB6u4=
|
github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f h1:5CjVwnuUcp5adK4gmY6i72gpVFVnZDP2h5TmPScB6u4=
|
||||||
github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f/go.mod h1:nOFQdrUlIlx6M6ODdSpBj1NVA+VgLC6kmw60mkw34H4=
|
github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f/go.mod h1:nOFQdrUlIlx6M6ODdSpBj1NVA+VgLC6kmw60mkw34H4=
|
||||||
github.com/lucasb-eyer/go-colorful v1.0.3 h1:QIbQXiugsb+q10B+MI+7DI1oQLdmnep86tWFlaaUAac=
|
github.com/lucasb-eyer/go-colorful v1.0.3 h1:QIbQXiugsb+q10B+MI+7DI1oQLdmnep86tWFlaaUAac=
|
||||||
github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
|
github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
|
||||||
github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
|
github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
|
||||||
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
|
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
|
||||||
github.com/muesli/termenv v0.5.3-0.20200526053627-d728968dcf83 h1:AfshZBlqAwhCZ27NJ1aPlMcPBihF1squ1GpaollhLQk=
|
github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
|
||||||
github.com/muesli/termenv v0.5.3-0.20200526053627-d728968dcf83/go.mod h1:O1/I6sw+6KcrgAmcs6uiUVr7Lui+DNVbHTzt9Lm/PlI=
|
github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
|
||||||
github.com/pkg/term v0.0.0-20200520122047-c3ffed290a03 h1:pd4YKIqCB0U7O2I4gWHgEUA2mCEOENmco0l/bM957bU=
|
github.com/muesli/termenv v0.7.2 h1:r1raklL3uKE7rOvWgSenmEm2px+dnc33OTisZ8YR1fw=
|
||||||
github.com/pkg/term v0.0.0-20200520122047-c3ffed290a03/go.mod h1:Z9+Ul5bCbBKnbCvdOWbLqTHhJiYV414CURZJba6L8qA=
|
github.com/muesli/termenv v0.7.2/go.mod h1:ct2L5N2lmix82RaY3bMWwVu/jUFc9Ule0KGDCiKYPh8=
|
||||||
|
github.com/muesli/termenv v0.7.4 h1:/pBqvU5CpkY53tU0vVn+xgs2ZTX63aH5nY+SSps5Xa8=
|
||||||
|
github.com/muesli/termenv v0.7.4/go.mod h1:pZ7qY9l3F7e5xsAOS0zCew2tME+p7bWeBkotCEcIIcc=
|
||||||
|
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
||||||
|
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||||
golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37 h1:cg5LA/zNPRzIXIWSCxQW10Rvpy94aQh3LT/ShoCpkHw=
|
golang.org/x/crypto v0.0.0-20201012173705-84dcc777aaee h1:4yd7jl+vXjalO5ztz6Vc1VADv+S/80LGJmyl1ROJ2AI=
|
||||||
golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
golang.org/x/crypto v0.0.0-20201012173705-84dcc777aaee/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||||
golang.org/x/crypto v0.0.0-20200604202706-70a84ac30bf9 h1:vEg9joUBmeBcK9iSJftGNf3coIG4HqZElCPehJsfAYM=
|
golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897 h1:pLI5jrR7OSLijeIDcmRxNmw2api+jEfxLoykJVice/E=
|
||||||
golang.org/x/crypto v0.0.0-20200604202706-70a84ac30bf9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20200523222454-059865788121 h1:rITEj+UZHYC927n8GT97eC3zrpzXdb/voyeOuVKS46o=
|
golang.org/x/sys v0.0.0-20200916030750-2334cc1a136f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20201009025420-dfb3f7c4e634 h1:bNEHhJCnrwMKNMmOx3yAynp5vs5/gRy+XWFtZFu7NBM=
|
||||||
golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980 h1:OjiUf46hAmXblsZdnoSXsEUSKU8r1UEzcL5RVZ4gO9Y=
|
golang.org/x/sys v0.0.0-20201009025420-dfb3f7c4e634/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20201020230747-6e5568b54d1a h1:e3IU37lwO4aq3uoRKINC7JikojFmE5gO7xhfxs8VC34=
|
||||||
|
golang.org/x/sys v0.0.0-20201020230747-6e5568b54d1a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||||
|
@@ -13,7 +13,7 @@ import (
|
|||||||
// Type specifies the way we render pagination.
|
// Type specifies the way we render pagination.
|
||||||
type Type int
|
type Type int
|
||||||
|
|
||||||
// Pagination rendering options
|
// Pagination rendering options.
|
||||||
const (
|
const (
|
||||||
Arabic Type = iota
|
Arabic Type = iota
|
||||||
Dots
|
Dots
|
||||||
@@ -21,17 +21,18 @@ const (
|
|||||||
|
|
||||||
// Model is the Tea model for this user interface.
|
// Model is the Tea model for this user interface.
|
||||||
type Model struct {
|
type Model struct {
|
||||||
Type Type
|
Type Type
|
||||||
Page int
|
Page int
|
||||||
PerPage int
|
PerPage int
|
||||||
TotalPages int
|
TotalPages int
|
||||||
ActiveDot string
|
ActiveDot string
|
||||||
InactiveDot string
|
InactiveDot string
|
||||||
ArabicFormat string
|
ArabicFormat string
|
||||||
UseLeftRightKeys bool
|
UsePgUpPgDownKeys bool
|
||||||
UseUpDownKeys bool
|
UseLeftRightKeys bool
|
||||||
UseHLKeys bool
|
UseUpDownKeys bool
|
||||||
UseJKKeys bool
|
UseHLKeys bool
|
||||||
|
UseJKKeys bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetTotalPages is a helper function for calculatng the total number of pages
|
// SetTotalPages is a helper function for calculatng the total number of pages
|
||||||
@@ -98,17 +99,18 @@ func (m Model) OnLastPage() bool {
|
|||||||
// NewModel creates a new model with defaults.
|
// NewModel creates a new model with defaults.
|
||||||
func NewModel() Model {
|
func NewModel() Model {
|
||||||
return Model{
|
return Model{
|
||||||
Type: Arabic,
|
Type: Arabic,
|
||||||
Page: 0,
|
Page: 0,
|
||||||
PerPage: 1,
|
PerPage: 1,
|
||||||
TotalPages: 1,
|
TotalPages: 1,
|
||||||
ActiveDot: "•",
|
ActiveDot: "•",
|
||||||
InactiveDot: "○",
|
InactiveDot: "○",
|
||||||
ArabicFormat: "%d/%d",
|
ArabicFormat: "%d/%d",
|
||||||
UseLeftRightKeys: true,
|
UsePgUpPgDownKeys: true,
|
||||||
UseUpDownKeys: false,
|
UseLeftRightKeys: true,
|
||||||
UseHLKeys: true,
|
UseUpDownKeys: false,
|
||||||
UseJKKeys: false,
|
UseHLKeys: true,
|
||||||
|
UseJKKeys: false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -116,6 +118,14 @@ func NewModel() Model {
|
|||||||
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
||||||
switch msg := msg.(type) {
|
switch msg := msg.(type) {
|
||||||
case tea.KeyMsg:
|
case tea.KeyMsg:
|
||||||
|
if m.UsePgUpPgDownKeys {
|
||||||
|
switch msg.String() {
|
||||||
|
case "pgup":
|
||||||
|
m.PrevPage()
|
||||||
|
case "pgdown":
|
||||||
|
m.NextPage()
|
||||||
|
}
|
||||||
|
}
|
||||||
if m.UseLeftRightKeys {
|
if m.UseLeftRightKeys {
|
||||||
switch msg.String() {
|
switch msg.String() {
|
||||||
case "left":
|
case "left":
|
||||||
@@ -154,11 +164,7 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// View renders the pagination to a string.
|
// View renders the pagination to a string.
|
||||||
func View(model tea.Model) string {
|
func View(m Model) string {
|
||||||
m, ok := model.(Model)
|
|
||||||
if !ok {
|
|
||||||
return "could not perform assertion on model"
|
|
||||||
}
|
|
||||||
switch m.Type {
|
switch m.Type {
|
||||||
case Dots:
|
case Dots:
|
||||||
return dotsView(m)
|
return dotsView(m)
|
||||||
|
@@ -7,25 +7,17 @@ import (
|
|||||||
"github.com/muesli/termenv"
|
"github.com/muesli/termenv"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
defaultFPS = time.Second / 10
|
||||||
|
)
|
||||||
|
|
||||||
// Spinner is a set of frames used in animating the spinner.
|
// Spinner is a set of frames used in animating the spinner.
|
||||||
type Spinner = int
|
type Spinner = []string
|
||||||
|
|
||||||
// Available types of spinners
|
|
||||||
const (
|
|
||||||
Line Spinner = iota
|
|
||||||
Dot
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
defaultFPS = 9
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
var (
|
||||||
// Spinner frames
|
// Some spinners to choose from. You could also make your own.
|
||||||
spinners = map[Spinner][]string{
|
Line = Spinner([]string{"|", "/", "-", "\\"})
|
||||||
Line: {"|", "/", "-", "\\"},
|
Dot = Spinner([]string{"⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ "})
|
||||||
Dot: {"⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ "},
|
|
||||||
}
|
|
||||||
|
|
||||||
color = termenv.ColorProfile().Color
|
color = termenv.ColorProfile().Color
|
||||||
)
|
)
|
||||||
@@ -35,10 +27,10 @@ var (
|
|||||||
type Model struct {
|
type Model struct {
|
||||||
|
|
||||||
// Type is the set of frames to use. See Spinner.
|
// Type is the set of frames to use. See Spinner.
|
||||||
Type Spinner
|
Frames Spinner
|
||||||
|
|
||||||
// FPS is the speed at which the ticker should tick
|
// FPS is the speed at which the ticker should tick.
|
||||||
FPS int
|
FPS time.Duration
|
||||||
|
|
||||||
// ForegroundColor sets the background color of the spinner. It can be a
|
// ForegroundColor sets the background color of the spinner. It can be a
|
||||||
// hex code or one of the 256 ANSI colors. If the terminal emulator can't
|
// hex code or one of the 256 ANSI colors. If the terminal emulator can't
|
||||||
@@ -52,67 +44,129 @@ type Model struct {
|
|||||||
// (per github.com/muesli/termenv).
|
// (per github.com/muesli/termenv).
|
||||||
BackgroundColor string
|
BackgroundColor string
|
||||||
|
|
||||||
// CustomMsgFunc can be used to a custom message on tick. This can be
|
// MinimumLifetime is the minimum amount of time the spinner can run. Any
|
||||||
// useful when you have spinners in different parts of your application and
|
// logic around this can be implemented in view that implements this
|
||||||
// want to differentiate between the messages for clarity and simplicity.
|
// spinner. If HideFor is set MinimumLifetime will be added on top of
|
||||||
// If nil, this setting is ignored.
|
// HideFor. In other words, if HideFor is 100ms and MinimumLifetime is
|
||||||
CustomMsgFunc func() tea.Msg
|
// 200ms then MinimumLifetime will expire after 300ms.
|
||||||
|
//
|
||||||
|
// MinimumLifetime is optional.
|
||||||
|
//
|
||||||
|
// This is considered experimental and may not appear in future versions of
|
||||||
|
// this library.
|
||||||
|
MinimumLifetime time.Duration
|
||||||
|
|
||||||
frame int
|
// HideFor can be used to wait to show the spinner until a certain amount
|
||||||
|
// of time has passed. This can be useful for preventing flicking when load
|
||||||
|
// times are very fast.
|
||||||
|
// Optional.
|
||||||
|
//
|
||||||
|
// This is considered experimental and may not appear in future versions of
|
||||||
|
// this library.
|
||||||
|
HideFor time.Duration
|
||||||
|
|
||||||
|
frame int
|
||||||
|
startTime time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start resets resets the spinner start time. For use with MinimumLifetime and
|
||||||
|
// MinimumStartTime. Optional.
|
||||||
|
//
|
||||||
|
// This is considered experimental and may not appear in future versions of
|
||||||
|
// this library.
|
||||||
|
func (m *Model) Start() {
|
||||||
|
m.startTime = time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
// hidden returns whether or not Model.HideFor is in effect.
|
||||||
|
func (m Model) hidden() bool {
|
||||||
|
if m.startTime.IsZero() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if m.HideFor == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return m.startTime.Add(m.HideFor).After(time.Now())
|
||||||
|
}
|
||||||
|
|
||||||
|
// finished returns whether Model.MinimumLifetimeReached has been met.
|
||||||
|
func (m Model) finished() bool {
|
||||||
|
if m.startTime.IsZero() {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if m.MinimumLifetime == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return m.startTime.Add(m.HideFor).Add(m.MinimumLifetime).Before(time.Now())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Visible returns whether or not the view should be rendered. Works in
|
||||||
|
// conjunction with Model.HideFor and Model.MinimumLifetimeReached. You should
|
||||||
|
// use this message directly to determine whether or not to render this view in
|
||||||
|
// the parent view and whether to continue sending spin messaging in the
|
||||||
|
// parent update function.
|
||||||
|
//
|
||||||
|
// Also note that using this function is optional and generally considered for
|
||||||
|
// advanced use only. Most of the time your application logic will determine
|
||||||
|
// whether or not this view should be used.
|
||||||
|
//
|
||||||
|
// This is considered experimental and may not appear in future versions of
|
||||||
|
// this library.
|
||||||
|
func (m Model) Visible() bool {
|
||||||
|
return !m.hidden() && !m.finished()
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewModel returns a model with default values.
|
// NewModel returns a model with default values.
|
||||||
func NewModel() Model {
|
func NewModel() Model {
|
||||||
return Model{
|
return Model{
|
||||||
Type: Line,
|
Frames: Line,
|
||||||
FPS: defaultFPS,
|
FPS: defaultFPS,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TickMsg indicates that the timer has ticked and we should render a frame.
|
// TickMsg indicates that the timer has ticked and we should render a frame.
|
||||||
type TickMsg struct{}
|
type TickMsg struct {
|
||||||
|
Time time.Time
|
||||||
|
}
|
||||||
|
|
||||||
// Update is the Tea update function. This will advance the spinner one frame
|
// Update is the Tea update function. This will advance the spinner one frame
|
||||||
// every time it's called, regardless the message passed, so be sure the logic
|
// every time it's called, regardless the message passed, so be sure the logic
|
||||||
// is setup so as not to call this Update needlessly.
|
// is setup so as not to call this Update needlessly.
|
||||||
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
||||||
m.frame++
|
if _, ok := msg.(TickMsg); ok {
|
||||||
if m.frame >= len(spinners[m.Type]) {
|
m.frame++
|
||||||
m.frame = 0
|
if m.frame >= len(m.Frames) {
|
||||||
}
|
m.frame = 0
|
||||||
if m.CustomMsgFunc != nil {
|
}
|
||||||
return m, Tick(m)
|
return m, Tick(m)
|
||||||
}
|
}
|
||||||
return m, Tick(m)
|
return m, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// View renders the model's view.
|
// View renders the model's view.
|
||||||
func View(model Model) string {
|
func View(model Model) string {
|
||||||
s := spinners[model.Type]
|
if model.frame >= len(model.Frames) {
|
||||||
if model.frame >= len(s) {
|
return "error"
|
||||||
return "[error]"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
str := s[model.frame]
|
frame := model.Frames[model.frame]
|
||||||
|
|
||||||
if model.ForegroundColor != "" || model.BackgroundColor != "" {
|
if model.ForegroundColor != "" || model.BackgroundColor != "" {
|
||||||
return termenv.
|
return termenv.
|
||||||
String(str).
|
String(frame).
|
||||||
Foreground(color(model.ForegroundColor)).
|
Foreground(color(model.ForegroundColor)).
|
||||||
Background(color(model.BackgroundColor)).
|
Background(color(model.BackgroundColor)).
|
||||||
String()
|
String()
|
||||||
}
|
}
|
||||||
|
|
||||||
return str
|
return frame
|
||||||
}
|
}
|
||||||
|
|
||||||
// Tick is the command used to advance the spinner one frame.
|
// Tick is the command used to advance the spinner one frame.
|
||||||
func Tick(model Model) tea.Cmd {
|
func Tick(m Model) tea.Cmd {
|
||||||
return func() tea.Msg {
|
return tea.Tick(m.FPS, func(t time.Time) tea.Msg {
|
||||||
time.Sleep(time.Second / time.Duration(model.FPS))
|
return TickMsg{
|
||||||
if model.CustomMsgFunc != nil {
|
Time: t,
|
||||||
return model.CustomMsgFunc()
|
|
||||||
}
|
}
|
||||||
return TickMsg{}
|
})
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@@ -5,36 +5,55 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
"unicode"
|
"unicode"
|
||||||
|
|
||||||
|
"github.com/atotto/clipboard"
|
||||||
tea "github.com/charmbracelet/bubbletea"
|
tea "github.com/charmbracelet/bubbletea"
|
||||||
|
rw "github.com/mattn/go-runewidth"
|
||||||
"github.com/muesli/termenv"
|
"github.com/muesli/termenv"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const defaultBlinkSpeed = time.Millisecond * 600
|
||||||
|
|
||||||
const (
|
const (
|
||||||
defaultBlinkSpeed = time.Millisecond * 600
|
// EchoNormal displays text as is. This is the default behavior.
|
||||||
|
EchoNormal EchoMode = iota
|
||||||
|
|
||||||
|
// EchoPassword displays the EchoCharacter mask instead of actual
|
||||||
|
// characters. This is commonly used for password fields.
|
||||||
|
EchoPassword
|
||||||
|
|
||||||
|
// EchoNone displays nothing as characters are entered. This is commonly
|
||||||
|
// seen for password fields on the command line.
|
||||||
|
EchoNone
|
||||||
|
|
||||||
|
// EchoOnEdit
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// EchoMode sets the input behavior of the text input field.
|
||||||
|
type EchoMode int
|
||||||
|
|
||||||
var (
|
var (
|
||||||
// color is a helper for returning colors
|
// color is a helper for returning colors.
|
||||||
color func(s string) termenv.Color = termenv.ColorProfile().Color
|
color func(s string) termenv.Color = termenv.ColorProfile().Color
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrMsg indicates there's been an error. We don't handle errors in the this
|
// Model is the Bubble Tea model for this text input element.
|
||||||
// package; we're expecting errors to be handle in the program that implements
|
|
||||||
// this text input.
|
|
||||||
type ErrMsg error
|
|
||||||
|
|
||||||
// Model is the Tea model for this text input element.
|
|
||||||
type Model struct {
|
type Model struct {
|
||||||
Err error
|
Err error
|
||||||
Prompt string
|
|
||||||
Cursor string
|
Prompt string
|
||||||
BlinkSpeed time.Duration
|
Placeholder string
|
||||||
Placeholder string
|
|
||||||
|
Cursor string
|
||||||
|
BlinkSpeed time.Duration
|
||||||
|
|
||||||
TextColor string
|
TextColor string
|
||||||
BackgroundColor string
|
BackgroundColor string
|
||||||
PlaceholderColor string
|
PlaceholderColor string
|
||||||
CursorColor string
|
CursorColor string
|
||||||
|
|
||||||
|
EchoMode EchoMode
|
||||||
|
EchoCharacter rune
|
||||||
|
|
||||||
// CharLimit is the maximum amount of characters this input element will
|
// CharLimit is the maximum amount of characters this input element will
|
||||||
// accept. If 0 or less, there's no limit.
|
// accept. If 0 or less, there's no limit.
|
||||||
CharLimit int
|
CharLimit int
|
||||||
@@ -44,30 +63,32 @@ 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
|
||||||
|
|
||||||
// Underlying text value
|
// Underlying text value.
|
||||||
value string
|
value []rune
|
||||||
|
|
||||||
// Focus indicates whether user input focus should be on this input
|
// Focus indicates whether user input focus should be on this input
|
||||||
// component. When false, don't blink and ignore keyboard input.
|
// component. When false, don't blink and ignore keyboard input.
|
||||||
focus bool
|
focus bool
|
||||||
|
|
||||||
// Cursor blink state
|
// Cursor blink state.
|
||||||
blink bool
|
blink bool
|
||||||
|
|
||||||
// Cursor position
|
// Cursor position.
|
||||||
pos int
|
pos int
|
||||||
|
|
||||||
// Used to emulate a viewport when width is set and the content is
|
// Used to emulate a viewport when width is set and the content is
|
||||||
// overflowing
|
// overflowing.
|
||||||
offset int
|
offset int
|
||||||
|
offsetRight int
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetValue sets the value of the text input.
|
// SetValue sets the value of the text input.
|
||||||
func (m *Model) SetValue(s string) {
|
func (m *Model) SetValue(s string) {
|
||||||
if m.CharLimit > 0 && len(s) > m.CharLimit {
|
runes := []rune(s)
|
||||||
m.value = s[:m.CharLimit]
|
if m.CharLimit > 0 && len(runes) > m.CharLimit {
|
||||||
|
m.value = runes[:m.CharLimit]
|
||||||
} else {
|
} else {
|
||||||
m.value = s
|
m.value = runes
|
||||||
}
|
}
|
||||||
if m.pos > len(m.value) {
|
if m.pos > len(m.value) {
|
||||||
m.pos = len(m.value)
|
m.pos = len(m.value)
|
||||||
@@ -77,13 +98,13 @@ func (m *Model) SetValue(s string) {
|
|||||||
|
|
||||||
// Value returns the value of the text input.
|
// Value returns the value of the text input.
|
||||||
func (m Model) Value() string {
|
func (m Model) Value() string {
|
||||||
return m.value
|
return string(m.value)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cursor start moves the cursor to the given position. If the position is out
|
// SetCursor start moves the cursor to the given position. If the position is
|
||||||
// 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.pos = max(0, min(len(m.value), pos))
|
m.pos = clamp(pos, 0, len(m.value))
|
||||||
m.handleOverflow()
|
m.handleOverflow()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -118,23 +139,94 @@ func (m *Model) Blur() {
|
|||||||
|
|
||||||
// Reset sets the input to its default state with no input.
|
// Reset sets the input to its default state with no input.
|
||||||
func (m *Model) Reset() {
|
func (m *Model) Reset() {
|
||||||
m.value = ""
|
m.value = nil
|
||||||
m.offset = 0
|
|
||||||
m.pos = 0
|
m.pos = 0
|
||||||
m.blink = false
|
m.blink = false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Paste pastes the contents of the clipboard into the text area (if supported).
|
||||||
|
func (m *Model) Paste() {
|
||||||
|
pasteString, err := clipboard.ReadAll()
|
||||||
|
if err != nil {
|
||||||
|
m.Err = err
|
||||||
|
}
|
||||||
|
paste := []rune(pasteString)
|
||||||
|
|
||||||
|
availSpace := m.CharLimit - len(m.value)
|
||||||
|
|
||||||
|
// If the char limit's been reached cancel
|
||||||
|
if m.CharLimit > 0 && availSpace <= 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// If there's not enough space to paste the whole thing cut the pasted
|
||||||
|
// runes down so they'll fit
|
||||||
|
if availSpace < len(paste) {
|
||||||
|
paste = paste[:len(paste)-availSpace]
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stuff before and after the cursor
|
||||||
|
head := m.value[:m.pos]
|
||||||
|
tailSrc := m.value[m.pos:]
|
||||||
|
tail := make([]rune, len(tailSrc))
|
||||||
|
copy(tail, tailSrc)
|
||||||
|
|
||||||
|
// Insert pasted runes
|
||||||
|
for _, r := range paste {
|
||||||
|
head = append(head, r)
|
||||||
|
availSpace--
|
||||||
|
m.pos++
|
||||||
|
if m.CharLimit > 0 && availSpace <= 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put it all back together
|
||||||
|
m.value = append(head, tail...)
|
||||||
|
}
|
||||||
|
|
||||||
// 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
|
||||||
// as a horizontally scrolling viewport.
|
// as a horizontally scrolling viewport.
|
||||||
func (m *Model) handleOverflow() {
|
func (m *Model) handleOverflow() {
|
||||||
if m.Width > 0 {
|
if m.Width <= 0 || rw.StringWidth(string(m.value)) <= m.Width {
|
||||||
overflow := max(0, len(m.value)-m.Width)
|
m.offset = 0
|
||||||
|
m.offsetRight = len(m.value)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
if overflow > 0 && m.pos < m.offset {
|
// Correct right offset if we've deleted characters
|
||||||
m.offset = max(0, min(len(m.value), m.pos))
|
m.offsetRight = min(m.offsetRight, len(m.value))
|
||||||
} else if overflow > 0 && m.pos >= m.offset+m.Width {
|
|
||||||
m.offset = max(0, m.pos-m.Width)
|
if m.pos < m.offset {
|
||||||
|
m.offset = m.pos
|
||||||
|
|
||||||
|
w := 0
|
||||||
|
i := 0
|
||||||
|
runes := m.value[m.offset:]
|
||||||
|
|
||||||
|
for i < len(runes) && w <= m.Width {
|
||||||
|
w += rw.RuneWidth(runes[i])
|
||||||
|
if w <= m.Width+1 {
|
||||||
|
i++
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
m.offsetRight = m.offset + i
|
||||||
|
} else if m.pos >= m.offsetRight {
|
||||||
|
m.offsetRight = m.pos
|
||||||
|
|
||||||
|
w := 0
|
||||||
|
runes := m.value[:m.offsetRight]
|
||||||
|
i := len(runes) - 1
|
||||||
|
|
||||||
|
for i > 0 && w < m.Width {
|
||||||
|
w += rw.RuneWidth(runes[i])
|
||||||
|
if w <= m.Width {
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m.offset = m.offsetRight - (len(runes) - 1 - i)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -166,7 +258,7 @@ func (m *Model) wordLeft() {
|
|||||||
i := m.pos - 1
|
i := m.pos - 1
|
||||||
|
|
||||||
for i >= 0 {
|
for i >= 0 {
|
||||||
if unicode.IsSpace(rune(m.value[i])) {
|
if unicode.IsSpace(m.value[i]) {
|
||||||
m.pos--
|
m.pos--
|
||||||
i--
|
i--
|
||||||
} else {
|
} else {
|
||||||
@@ -175,7 +267,7 @@ func (m *Model) wordLeft() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for i >= 0 {
|
for i >= 0 {
|
||||||
if !unicode.IsSpace(rune(m.value[i])) {
|
if !unicode.IsSpace(m.value[i]) {
|
||||||
m.pos--
|
m.pos--
|
||||||
i--
|
i--
|
||||||
} else {
|
} else {
|
||||||
@@ -192,7 +284,7 @@ func (m *Model) wordRight() {
|
|||||||
i := m.pos
|
i := m.pos
|
||||||
|
|
||||||
for i < len(m.value) {
|
for i < len(m.value) {
|
||||||
if unicode.IsSpace(rune(m.value[i])) {
|
if unicode.IsSpace(m.value[i]) {
|
||||||
m.pos++
|
m.pos++
|
||||||
i++
|
i++
|
||||||
} else {
|
} else {
|
||||||
@@ -201,7 +293,7 @@ func (m *Model) wordRight() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for i < len(m.value) {
|
for i < len(m.value) {
|
||||||
if !unicode.IsSpace(rune(m.value[i])) {
|
if !unicode.IsSpace(m.value[i]) {
|
||||||
m.pos++
|
m.pos++
|
||||||
i++
|
i++
|
||||||
} else {
|
} else {
|
||||||
@@ -210,21 +302,38 @@ func (m *Model) wordRight() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (m Model) echoTransform(v string) string {
|
||||||
|
switch m.EchoMode {
|
||||||
|
case EchoPassword:
|
||||||
|
return strings.Repeat(string(m.EchoCharacter), rw.StringWidth(v))
|
||||||
|
case EchoNone:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
default:
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// BlinkMsg is sent when the cursor should alternate it's blinking state.
|
// BlinkMsg is sent when the cursor should alternate it's blinking state.
|
||||||
type BlinkMsg struct{}
|
type BlinkMsg struct{}
|
||||||
|
|
||||||
// NewModel creates a new model with default settings.
|
// NewModel creates a new model with default settings.
|
||||||
func NewModel() Model {
|
func NewModel() Model {
|
||||||
return Model{
|
return Model{
|
||||||
Prompt: "> ",
|
Prompt: "> ",
|
||||||
BlinkSpeed: defaultBlinkSpeed,
|
Placeholder: "",
|
||||||
Placeholder: "",
|
|
||||||
|
BlinkSpeed: defaultBlinkSpeed,
|
||||||
|
|
||||||
TextColor: "",
|
TextColor: "",
|
||||||
PlaceholderColor: "240",
|
PlaceholderColor: "240",
|
||||||
CursorColor: "",
|
CursorColor: "",
|
||||||
CharLimit: 0,
|
|
||||||
|
|
||||||
value: "",
|
EchoCharacter: '*',
|
||||||
|
|
||||||
|
CharLimit: 0,
|
||||||
|
|
||||||
|
value: nil,
|
||||||
focus: false,
|
focus: false,
|
||||||
blink: true,
|
blink: true,
|
||||||
pos: 0,
|
pos: 0,
|
||||||
@@ -241,12 +350,12 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
|||||||
switch msg := msg.(type) {
|
switch msg := msg.(type) {
|
||||||
case tea.KeyMsg:
|
case tea.KeyMsg:
|
||||||
switch msg.Type {
|
switch msg.Type {
|
||||||
case tea.KeyBackspace:
|
case tea.KeyBackspace: // delete character before cursor
|
||||||
fallthrough
|
|
||||||
case tea.KeyDelete:
|
|
||||||
if len(m.value) > 0 {
|
if len(m.value) > 0 {
|
||||||
m.value = m.value[:m.pos-1] + m.value[m.pos:]
|
m.value = append(m.value[:max(0, m.pos-1)], m.value[m.pos:]...)
|
||||||
m.pos--
|
if m.pos > 0 {
|
||||||
|
m.pos--
|
||||||
|
}
|
||||||
}
|
}
|
||||||
case tea.KeyLeft:
|
case tea.KeyLeft:
|
||||||
if msg.Alt { // alt+left arrow, back one word
|
if msg.Alt { // alt+left arrow, back one word
|
||||||
@@ -268,13 +377,13 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
|||||||
fallthrough
|
fallthrough
|
||||||
case tea.KeyCtrlB: // ^B, back one charcter
|
case tea.KeyCtrlB: // ^B, back one charcter
|
||||||
fallthrough
|
fallthrough
|
||||||
case tea.KeyCtrlA: // ^A, go to beginning
|
case tea.KeyHome, tea.KeyCtrlA: // ^A, go to beginning
|
||||||
m.CursorStart()
|
m.CursorStart()
|
||||||
case 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 = m.value[:m.pos] + m.value[m.pos+1:]
|
m.value = append(m.value[:m.pos], m.value[m.pos+1:]...)
|
||||||
}
|
}
|
||||||
case tea.KeyCtrlE: // ^E, go to end
|
case tea.KeyCtrlE, tea.KeyEnd: // ^E, go to end
|
||||||
m.CursorEnd()
|
m.CursorEnd()
|
||||||
case tea.KeyCtrlK: // ^K, kill text after cursor
|
case tea.KeyCtrlK: // ^K, kill text after cursor
|
||||||
m.value = m.value[:m.pos]
|
m.value = m.value[:m.pos]
|
||||||
@@ -283,6 +392,8 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
|||||||
m.value = m.value[m.pos:]
|
m.value = m.value[m.pos:]
|
||||||
m.pos = 0
|
m.pos = 0
|
||||||
m.offset = 0
|
m.offset = 0
|
||||||
|
case tea.KeyCtrlV: // ^V paste
|
||||||
|
m.Paste()
|
||||||
case tea.KeyRune: // input a regular character
|
case tea.KeyRune: // input a regular character
|
||||||
|
|
||||||
if msg.Alt {
|
if msg.Alt {
|
||||||
@@ -298,14 +409,11 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
|||||||
|
|
||||||
// Input a regular character
|
// Input a regular character
|
||||||
if m.CharLimit <= 0 || len(m.value) < m.CharLimit {
|
if m.CharLimit <= 0 || len(m.value) < m.CharLimit {
|
||||||
m.value = m.value[:m.pos] + string(msg.Rune) + m.value[m.pos:]
|
m.value = append(m.value[:m.pos], append([]rune{msg.Rune}, m.value[m.pos:]...)...)
|
||||||
m.pos++
|
m.pos++
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
case ErrMsg:
|
|
||||||
m.Err = msg
|
|
||||||
|
|
||||||
case BlinkMsg:
|
case BlinkMsg:
|
||||||
m.blink = !m.blink
|
m.blink = !m.blink
|
||||||
return m, Blink(m)
|
return m, Blink(m)
|
||||||
@@ -317,41 +425,29 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// View renders the textinput in its current state.
|
// View renders the textinput in its current state.
|
||||||
func View(model tea.Model) string {
|
func View(m Model) string {
|
||||||
m, ok := model.(Model)
|
|
||||||
if !ok {
|
|
||||||
return "could not perform assertion on model"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Placeholder text
|
// Placeholder text
|
||||||
if m.value == "" && m.Placeholder != "" {
|
if len(m.value) == 0 && m.Placeholder != "" {
|
||||||
return placeholderView(m)
|
return placeholderView(m)
|
||||||
}
|
}
|
||||||
|
|
||||||
left := m.offset
|
value := m.value[m.offset:m.offsetRight]
|
||||||
right := 0
|
pos := max(0, m.pos-m.offset)
|
||||||
if m.Width > 0 {
|
v := m.colorText(m.echoTransform(string(value[:pos])))
|
||||||
right = min(len(m.value), m.offset+m.Width+1)
|
|
||||||
} else {
|
|
||||||
right = len(m.value)
|
|
||||||
}
|
|
||||||
value := m.value[left:right]
|
|
||||||
pos := m.pos - m.offset
|
|
||||||
|
|
||||||
v := m.colorText(value[:pos])
|
|
||||||
|
|
||||||
if pos < len(value) {
|
if pos < len(value) {
|
||||||
v += cursorView(string(value[pos]), m) // cursor and text under it
|
v += cursorView(m.echoTransform(string(value[pos])), m) // cursor and text under it
|
||||||
v += m.colorText(value[pos+1:]) // text after cursor
|
v += m.colorText(m.echoTransform(string(value[pos+1:]))) // text after cursor
|
||||||
} else {
|
} else {
|
||||||
v += cursorView(" ", m)
|
v += cursorView(" ", m)
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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
|
||||||
// the background color.
|
// the background color.
|
||||||
if m.Width > 0 && len(m.BackgroundColor) > 0 && len(value) <= m.Width {
|
valWidth := rw.StringWidth(string(value))
|
||||||
padding := m.Width - len(value)
|
if m.Width > 0 && len(m.BackgroundColor) > 0 && valWidth <= m.Width {
|
||||||
if len(value)+padding <= m.Width && pos < len(value) {
|
padding := max(0, m.Width-valWidth)
|
||||||
|
if valWidth+padding <= m.Width && pos < len(value) {
|
||||||
padding++
|
padding++
|
||||||
}
|
}
|
||||||
v += strings.Repeat(
|
v += strings.Repeat(
|
||||||
@@ -363,7 +459,7 @@ func View(model tea.Model) string {
|
|||||||
return m.Prompt + v
|
return m.Prompt + v
|
||||||
}
|
}
|
||||||
|
|
||||||
// placeholderView
|
// placeholderView.
|
||||||
func placeholderView(m Model) string {
|
func placeholderView(m Model) string {
|
||||||
var (
|
var (
|
||||||
v string
|
v string
|
||||||
@@ -372,10 +468,7 @@ func placeholderView(m Model) string {
|
|||||||
|
|
||||||
// Cursor
|
// Cursor
|
||||||
if m.blink && m.PlaceholderColor != "" {
|
if m.blink && m.PlaceholderColor != "" {
|
||||||
v += cursorView(
|
v += cursorView(m.colorPlaceholder(p[:1]), m)
|
||||||
m.colorPlaceholder(p[:1]),
|
|
||||||
m,
|
|
||||||
)
|
|
||||||
} else {
|
} else {
|
||||||
v += cursorView(p[:1], m)
|
v += cursorView(p[:1], m)
|
||||||
}
|
}
|
||||||
@@ -412,6 +505,10 @@ func Blink(model Model) tea.Cmd {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func clamp(v, low, high int) int {
|
||||||
|
return min(high, max(low, v))
|
||||||
|
}
|
||||||
|
|
||||||
func min(a, b int) int {
|
func min(a, b int) int {
|
||||||
if a < b {
|
if a < b {
|
||||||
return a
|
return a
|
||||||
|
@@ -1,147 +1,369 @@
|
|||||||
package viewport
|
package viewport
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"math"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
tea "github.com/charmbracelet/bubbletea"
|
tea "github.com/charmbracelet/bubbletea"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
spacebar = " "
|
||||||
|
)
|
||||||
|
|
||||||
// MODEL
|
// MODEL
|
||||||
|
|
||||||
type Model struct {
|
type Model struct {
|
||||||
Err error
|
|
||||||
Width int
|
Width int
|
||||||
Height int
|
Height int
|
||||||
Y int
|
|
||||||
|
// YOffset is the vertical scroll position.
|
||||||
|
YOffset int
|
||||||
|
|
||||||
|
// YPosition is the position of the viewport in relation to the terminal
|
||||||
|
// window. It's used in high performance rendering.
|
||||||
|
YPosition int
|
||||||
|
|
||||||
|
// HighPerformanceRendering bypasses the normal Bubble Tea renderer to
|
||||||
|
// provide higher performance rendering. Most of the time the normal Bubble
|
||||||
|
// Tea rendering methods will suffice, but if you're passing content with
|
||||||
|
// a lot of ANSI escape codes you may see improved rendering in certain
|
||||||
|
// terminals with this enabled.
|
||||||
|
//
|
||||||
|
// This should only be used in program occupying the entire terminal,
|
||||||
|
// which is usually via the alternate screen buffer.
|
||||||
|
HighPerformanceRendering bool
|
||||||
|
|
||||||
lines []string
|
lines []string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AtTop returns whether or not the viewport is in the very top position.
|
||||||
|
func (m Model) AtTop() bool {
|
||||||
|
return m.YOffset <= 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// AtBottom returns whether or not the viewport is at or past the very bottom
|
||||||
|
// position.
|
||||||
|
func (m Model) AtBottom() bool {
|
||||||
|
return m.YOffset >= len(m.lines)-1-m.Height
|
||||||
|
}
|
||||||
|
|
||||||
|
// PastBottom returns whether or not the viewport is scrolled beyond the last
|
||||||
|
// line. This can happen when adjusting the viewport height.
|
||||||
|
func (m Model) PastBottom() bool {
|
||||||
|
return m.YOffset > len(m.lines)-1-m.Height
|
||||||
|
}
|
||||||
|
|
||||||
// Scrollpercent returns the amount scrolled as a float between 0 and 1.
|
// Scrollpercent returns the amount scrolled as a float between 0 and 1.
|
||||||
func (m Model) ScrollPercent() float64 {
|
func (m Model) ScrollPercent() float64 {
|
||||||
if m.Height >= len(m.lines) {
|
if m.Height >= len(m.lines) {
|
||||||
return 1.0
|
return 1.0
|
||||||
}
|
}
|
||||||
y := float64(m.Y)
|
y := float64(m.YOffset)
|
||||||
h := float64(m.Height)
|
h := float64(m.Height)
|
||||||
t := float64(len(m.lines))
|
t := float64(len(m.lines) - 1)
|
||||||
return y / (t - h)
|
v := y / (t - h)
|
||||||
|
return math.Max(0.0, math.Min(1.0, v))
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetContent set the pager's text content.
|
// SetContent set the pager's text content. For high performance rendering the
|
||||||
|
// Sync command should also be called.
|
||||||
func (m *Model) SetContent(s string) {
|
func (m *Model) SetContent(s string) {
|
||||||
s = strings.Replace(s, "\r\n", "\n", -1) // normalize line endings
|
s = strings.Replace(s, "\r\n", "\n", -1) // normalize line endings
|
||||||
m.lines = strings.Split(s, "\n")
|
m.lines = strings.Split(s, "\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewModel creates a new pager model. Pass the dimensions of the pager.
|
// Return the lines that should currently be visible in the viewport.
|
||||||
func NewModel(width, height int) Model {
|
func (m Model) visibleLines() (lines []string) {
|
||||||
return Model{
|
if len(m.lines) > 0 {
|
||||||
Width: width,
|
top := max(0, m.YOffset)
|
||||||
Height: height,
|
bottom := min(len(m.lines), m.YOffset+m.Height)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
}
|
}
|
||||||
|
return lines
|
||||||
}
|
}
|
||||||
|
|
||||||
// ViewDown moves the view down by the number of lines in the viewport.
|
// ViewDown moves the view down by the number of lines in the viewport.
|
||||||
// Basically, "page down".
|
// Basically, "page down".
|
||||||
func (m *Model) ViewDown() {
|
func (m *Model) ViewDown() []string {
|
||||||
m.Y = min(len(m.lines)-m.Height, m.Y+m.Height)
|
if m.AtBottom() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
m.YOffset = min(
|
||||||
|
m.YOffset+m.Height, // target
|
||||||
|
len(m.lines)-1-m.Height, // fallback
|
||||||
|
)
|
||||||
|
|
||||||
|
return m.visibleLines()
|
||||||
}
|
}
|
||||||
|
|
||||||
// ViewUp moves the view up by one height of the viewport. Basically, "page up".
|
// ViewUp moves the view up by one height of the viewport. Basically, "page up".
|
||||||
func (m *Model) ViewUp() {
|
func (m *Model) ViewUp() []string {
|
||||||
m.Y = max(0, m.Y-m.Height)
|
if m.AtTop() {
|
||||||
}
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// HalfViewUp moves the view up by half the height of the viewport.
|
m.YOffset = max(
|
||||||
func (m *Model) HalfViewUp() {
|
m.YOffset-m.Height, // target
|
||||||
m.Y = max(0, m.Y-m.Height/2)
|
0, // fallback
|
||||||
|
)
|
||||||
|
|
||||||
|
return m.visibleLines()
|
||||||
}
|
}
|
||||||
|
|
||||||
// HalfViewDown moves the view down by half the height of the viewport.
|
// HalfViewDown moves the view down by half the height of the viewport.
|
||||||
func (m *Model) HalfViewDown() {
|
func (m *Model) HalfViewDown() (lines []string) {
|
||||||
m.Y = min(len(m.lines)-m.Height, m.Y+m.Height/2)
|
if m.AtBottom() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
m.YOffset = min(
|
||||||
|
m.YOffset+m.Height/2, // target
|
||||||
|
len(m.lines)-1-m.Height, // fallback
|
||||||
|
)
|
||||||
|
|
||||||
|
if len(m.lines) > 0 {
|
||||||
|
top := max(m.YOffset+m.Height/2, 0)
|
||||||
|
bottom := min(m.YOffset+m.Height, len(m.lines)-1)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines
|
||||||
}
|
}
|
||||||
|
|
||||||
// LineDown moves the view up by the given number of lines.
|
// HalfViewUp moves the view up by half the height of the viewport.
|
||||||
func (m *Model) LineDown(n int) {
|
func (m *Model) HalfViewUp() (lines []string) {
|
||||||
m.Y = min(len(m.lines)-m.Height, m.Y+n)
|
if m.AtTop() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
m.YOffset = max(
|
||||||
|
m.YOffset-m.Height/2, // target
|
||||||
|
0, // fallback
|
||||||
|
)
|
||||||
|
|
||||||
|
if len(m.lines) > 0 {
|
||||||
|
top := max(m.YOffset, 0)
|
||||||
|
bottom := min(m.YOffset+m.Height/2, len(m.lines)-1)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines
|
||||||
}
|
}
|
||||||
|
|
||||||
// LineDown moves the view down by the given number of lines.
|
// LineDown moves the view down by the given number of lines.
|
||||||
func (m *Model) LineUp(n int) {
|
func (m *Model) LineDown(n int) (lines []string) {
|
||||||
m.Y = max(0, m.Y-n)
|
if m.AtBottom() || n == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Make sure the number of lines by which we're going to scroll isn't
|
||||||
|
// greater than the number of lines we actually have left before we reach
|
||||||
|
// the bottom.
|
||||||
|
maxDelta := (len(m.lines) - 1) - (m.YOffset + m.Height) // number of lines - viewport bottom edge
|
||||||
|
n = min(n, maxDelta)
|
||||||
|
|
||||||
|
m.YOffset = min(
|
||||||
|
m.YOffset+n, // target
|
||||||
|
len(m.lines)-1-m.Height, // fallback
|
||||||
|
)
|
||||||
|
|
||||||
|
if len(m.lines) > 0 {
|
||||||
|
top := max(m.YOffset+m.Height-n, 0)
|
||||||
|
bottom := min(m.YOffset+m.Height, len(m.lines)-1)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines
|
||||||
|
}
|
||||||
|
|
||||||
|
// LineUp moves the view down by the given number of lines. Returns the new
|
||||||
|
// lines to show.
|
||||||
|
func (m *Model) LineUp(n int) (lines []string) {
|
||||||
|
if m.AtTop() || n == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Make sure the number of lines by which we're going to scroll isn't
|
||||||
|
// greater than the number of lines we are from the top.
|
||||||
|
n = min(n, m.YOffset)
|
||||||
|
|
||||||
|
m.YOffset = max(m.YOffset-n, 0)
|
||||||
|
|
||||||
|
if len(m.lines) > 0 {
|
||||||
|
top := max(0, m.YOffset)
|
||||||
|
bottom := min(m.YOffset+n, len(m.lines)-1)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines
|
||||||
|
}
|
||||||
|
|
||||||
|
// GotoTop sets the viewport to the top position.
|
||||||
|
func (m *Model) GotoTop() (lines []string) {
|
||||||
|
if m.AtTop() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
m.YOffset = 0
|
||||||
|
|
||||||
|
if len(m.lines) > 0 {
|
||||||
|
top := m.YOffset
|
||||||
|
bottom := min(m.YOffset+m.Height, len(m.lines)-1)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines
|
||||||
|
}
|
||||||
|
|
||||||
|
// GotoTop sets the viewport to the bottom position.
|
||||||
|
func (m *Model) GotoBottom() (lines []string) {
|
||||||
|
m.YOffset = max(len(m.lines)-1-m.Height, 0)
|
||||||
|
|
||||||
|
if len(m.lines) > 0 {
|
||||||
|
top := m.YOffset
|
||||||
|
bottom := max(len(m.lines)-1, 0)
|
||||||
|
lines = m.lines[top:bottom]
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines
|
||||||
|
}
|
||||||
|
|
||||||
|
// COMMANDS
|
||||||
|
|
||||||
|
// Sync tells the renderer where the viewport will be located and requests
|
||||||
|
// a render of the current state of the viewport. It should be called for the
|
||||||
|
// first render and after a window resize.
|
||||||
|
//
|
||||||
|
// For high performance rendering only.
|
||||||
|
func Sync(m Model) tea.Cmd {
|
||||||
|
if len(m.lines) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: we should probably use m.visibleLines() rather than these two
|
||||||
|
// expressions.
|
||||||
|
top := max(m.YOffset, 0)
|
||||||
|
bottom := min(m.YOffset+m.Height, len(m.lines)-1)
|
||||||
|
|
||||||
|
return tea.SyncScrollArea(
|
||||||
|
m.lines[top:bottom],
|
||||||
|
m.YPosition,
|
||||||
|
m.YPosition+m.Height,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ViewDown is a high performance command that moves the viewport up by a given
|
||||||
|
// numer of lines. Use Model.ViewDown to get the lines that should be rendered.
|
||||||
|
// For example:
|
||||||
|
//
|
||||||
|
// lines := model.ViewDown(1)
|
||||||
|
// cmd := ViewDown(m, lines)
|
||||||
|
//
|
||||||
|
func ViewDown(m Model, lines []string) tea.Cmd {
|
||||||
|
if len(lines) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return tea.ScrollDown(lines, m.YPosition, m.YPosition+m.Height)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ViewUp is a high performance command the moves the viewport down by a given
|
||||||
|
// number of lines height. Use Model.ViewDown to get the lines that should be
|
||||||
|
// rendered.
|
||||||
|
func ViewUp(m Model, lines []string) tea.Cmd {
|
||||||
|
if len(lines) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return tea.ScrollUp(lines, m.YPosition, m.YPosition+m.Height)
|
||||||
}
|
}
|
||||||
|
|
||||||
// UPDATE
|
// UPDATE
|
||||||
|
|
||||||
// Update runs the update loop with default keybindings. To define your own
|
// Update runs the update loop with default keybindings similar to popular
|
||||||
// keybindings use the methods on Model.
|
// pagers. To define your own keybindings use the methods on Model (i.e.
|
||||||
|
// Model.LineDown()) and define your own update function.
|
||||||
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
|
||||||
switch msg := msg.(type) {
|
var cmd tea.Cmd
|
||||||
|
|
||||||
|
switch msg := msg.(type) {
|
||||||
case tea.KeyMsg:
|
case tea.KeyMsg:
|
||||||
switch msg.String() {
|
switch msg.String() {
|
||||||
// Down one page
|
// Down one page
|
||||||
case "pgdown":
|
case "pgdown", spacebar, "f":
|
||||||
fallthrough
|
lines := m.ViewDown()
|
||||||
case " ": // spacebar
|
if m.HighPerformanceRendering {
|
||||||
fallthrough
|
cmd = ViewDown(m, lines)
|
||||||
case "f":
|
}
|
||||||
m.ViewDown()
|
|
||||||
return m, nil
|
|
||||||
|
|
||||||
// Up one page
|
// Up one page
|
||||||
case "pgup":
|
case "pgup", "b":
|
||||||
fallthrough
|
lines := m.ViewUp()
|
||||||
case "b":
|
if m.HighPerformanceRendering {
|
||||||
m.ViewUp()
|
cmd = ViewUp(m, lines)
|
||||||
return m, nil
|
}
|
||||||
|
|
||||||
// Down half page
|
// Down half page
|
||||||
case "d":
|
case "d", "ctrl+d":
|
||||||
m.HalfViewDown()
|
lines := m.HalfViewDown()
|
||||||
return m, nil
|
if m.HighPerformanceRendering {
|
||||||
|
cmd = ViewDown(m, lines)
|
||||||
|
}
|
||||||
|
|
||||||
// Up half page
|
// Up half page
|
||||||
case "u":
|
case "u", "ctrl+u":
|
||||||
m.HalfViewUp()
|
lines := m.HalfViewUp()
|
||||||
return m, nil
|
if m.HighPerformanceRendering {
|
||||||
|
cmd = ViewUp(m, lines)
|
||||||
|
}
|
||||||
|
|
||||||
// Down one line
|
// Down one line
|
||||||
case "down":
|
case "down", "j":
|
||||||
fallthrough
|
lines := m.LineDown(1)
|
||||||
case "j":
|
if m.HighPerformanceRendering {
|
||||||
m.LineDown(1)
|
cmd = ViewDown(m, lines)
|
||||||
return m, nil
|
}
|
||||||
|
|
||||||
// Up one line
|
// Up one line
|
||||||
case "up":
|
case "up", "k":
|
||||||
fallthrough
|
lines := m.LineUp(1)
|
||||||
case "k":
|
if m.HighPerformanceRendering {
|
||||||
m.LineUp(1)
|
cmd = ViewUp(m, lines)
|
||||||
return m, nil
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
case tea.MouseMsg:
|
||||||
|
switch msg.Type {
|
||||||
|
case tea.MouseWheelUp:
|
||||||
|
lines := m.LineUp(3)
|
||||||
|
if m.HighPerformanceRendering {
|
||||||
|
cmd = ViewUp(m, lines)
|
||||||
|
}
|
||||||
|
|
||||||
|
case tea.MouseWheelDown:
|
||||||
|
lines := m.LineDown(3)
|
||||||
|
if m.HighPerformanceRendering {
|
||||||
|
cmd = ViewDown(m, lines)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return m, nil
|
return m, cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
// VIEW
|
// VIEW
|
||||||
|
|
||||||
// View renders the viewport into a string.
|
// View renders the viewport into a string.
|
||||||
func View(m Model) string {
|
func View(m Model) string {
|
||||||
if m.Err != nil {
|
if m.HighPerformanceRendering {
|
||||||
return m.Err.Error()
|
// Just send newlines since we're doing to be rendering the actual
|
||||||
|
// content seprately. We still need send something that equals the
|
||||||
|
// height of this view so that the Bubble Tea standard renderer can
|
||||||
|
// position anything below this view properly.
|
||||||
|
return strings.Repeat("\n", m.Height-1)
|
||||||
}
|
}
|
||||||
|
|
||||||
var lines []string
|
lines := m.visibleLines()
|
||||||
|
|
||||||
if len(m.lines) > 0 {
|
|
||||||
top := max(0, m.Y)
|
|
||||||
bottom := min(len(m.lines), m.Y+m.Height)
|
|
||||||
lines = m.lines[top:bottom]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fill empty space with newlines
|
// Fill empty space with newlines
|
||||||
extraLines := ""
|
extraLines := ""
|
||||||
|
Reference in New Issue
Block a user