Maks1mS/bubbles
1
0
Fork 0
mirror of https://github.com/Maks1mS/bubbles.git synced 2024-12-23 22:32:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Link directly to example code and flesh out pagination component description

Browse Source
This commit is contained in:
Christian Rocha 2020-07-29 16:38:59 -04:00
parent 0cc5e71a63
commit 7fa53ea961
No known key found for this signature in database
GPG Key ID: D6CC7A16E5878018
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -18,7 +18,7 @@ These components are used in production in [Glow][glow] and [Charm][charm].
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](https://github.com/charmbracelet/tea/tree/master/examples/spinner)
* [Example code](https://github.com/charmbracelet/tea/tree/master/examples/spinner/main.go)
## Text Input
@ -27,15 +27,16 @@ 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.
An example of the text field
* [Example, one field](https://github.com/charmbracelet/tea/tree/master/examples/textinput)
* [Example, many fields](https://github.com/charmbracelet/tea/tree/master/examples/textinput)
* [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
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.
@ -47,7 +48,7 @@ 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](https://github.com/charmbracelet/tea/tree/master/examples/pager)
* [Example code](https://github.com/charmbracelet/tea/tree/master/examples/pager/main.go)
This compoent is well complimented with [Reflow][reflow] for ANSI-aware
indenting and text wrapping.