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

Flesh out README and add Charm badge

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

51
README.md
View File

@ -7,28 +7,63 @@ Some components for [Bubble Tea](https://github.com/charmbraclet/bubbletea):
* Paginator
* Viewport
[glow]: https://github.com/charmbraclet/glow
[charm]: https://github.com/charmbraclet/charm
These components are used in production in [Glow][glow] and [Charm][charm].
## Spinner
A spinner, useful for indicating that some kind of invisible operation is
happening. There are a couple default ones, but you can also pass your own
”frames.”
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)
## Text Input
A text input field, akin to an `<input type="text">` in HTML.
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)
## Paginator
A component for handling pagination logic and optionally drawing pagination UI.
This component is used in [Glow][glow] to browse documents and [Charm][charm] to
browse SSH keys.
## Viewport
A viewport for vertically scrolling content which optionally includes standard
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. This is
generally only necessary when dealing with content with a very large amount of
ANSI escape sequences.
for applications which make use of the alterate screen buffer.
* [Example](https://github.com/charmbracelet/tea/tree/master/examples/pager)
This compoent is well complimented with [Reflow][reflow] for ANSI-aware
indenting and text wrapping.
[reflow]: https://github.com/muesli/reflow
## License
[MIT](https://github.com/charmbracelet/teaparty/raw/master/LICENSE)
***
A [Charm](https://charm.sh) project.
<img alt="the Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400">
Charm热爱开源!