Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ttytm/bartender
Customizable progress indicators for V terminal applications.
https://github.com/ttytm/bartender
cli customizable gluten-free progress progress-bar progressbar terminal v vlang
Last synced: 10 days ago
JSON representation
Customizable progress indicators for V terminal applications.
- Host: GitHub
- URL: https://github.com/ttytm/bartender
- Owner: ttytm
- License: mit
- Created: 2023-03-17T15:56:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T16:56:08.000Z (25 days ago)
- Last Synced: 2024-12-07T20:43:46.280Z (14 days ago)
- Topics: cli, customizable, gluten-free, progress, progress-bar, progressbar, terminal, v, vlang
- Language: V
- Homepage:
- Size: 157 KB
- Stars: 51
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-v - bartender - Customizable progress indicators for V terminal applications. (Libraries / Command line interface (CLI) / Terminal / Shell)
README
# bartender
> Customizable bars for v term apps.
## Getting started
Install via `v` cli
- From source
```
v install --git https://github.com/tobealive/bartender
```
```v
import bartender
```
- As vpm module
```
v install tobealive.bartender
```
```v
import tobealive.bartender
```
## Usage examples
- Simple bars
```v
// Default bar
mut b := Bar{}
for _ in 0 .. b.iters {
b.progress()
}
// Customized bar
mut b2 := Bar{
width: 60
runes: BarRunes{
progress: `#`
indicator: `❯`
remaining: `-`
}
pre: '|'
post: Affix{
pending: '| Loading...'
finished: '| Done!'
}
}
for _ in 0 .. b2.iters {
b2.progress()
}
```
- Smooth bar themes
```v
mut b := SmoothBar{
theme: Theme.pull // Default = Theme.push
}
for _ in 0 .. b.iters {
b.progress()
}
b2 = SmoothBar{
theme: ThemeVariant{.pull, .drain}
}
for _ in 0 .. b2.iters {
b2.progress()
}
// Customized smooth bar
mut b3 := SmoothBar{
theme: Theme.split
width: 80
pre: '│'
post: fn (b SmoothBar) (string, string) {
return '│ Saving... ${b.pct()}% ${term.blue(b.eta(20))}', '│ Saved!'
}
}
b3.colorize(.cyan)
for _ in 0 .. b3.iters {
b3.progress()
}
```
- Bar Reader for `io` operations.
```v
// Returns an `io.BufferedReader` that displays a progressing bar when used in a reader operation.
pub fn (b Bar) reader(reader io.Reader, size u64) &io.BufferedReader
```
```v
mut src_file := os.open(src_file_path)!
mut dst_file := os.create(dst_file_path)!
bar := bartender.Bar{}
mut bar_reader := bar.reader(src_file, os.file_size(src_file_path))
io.cp(mut bar_reader, mut dst_file)!
```
### Run examples
Extended and executable examples can be found in the `examples` directory.
```
v run examples/.v
```
## Showcase
Simple bar Toggle visibility...
Color and style customizations. Toggle visibility...
Smooth bars. Toggle visibility...
## Disclaimer
Until a stable version 1.0 is available, new features will be introduced, existing ones may change,
or breaking changes may occur in minor(`0..*`) versions.
## Outlook
Below are some of the things to look forward to.
- [x] Reader Interface
- [x] Multiline (Smooth Bar Split Themes are not supported yet)
- [x] Time Remaining
- [ ] Dynamic adjustment on term resize for all variants (basic width detection works)
- [ ] Extend visuals & customizability
## Anowledgements
- [Waqar144/progressbar][10] inspired the start of project.
- [console-rs/indicatif][20] serves as inspiration for further development.
- [ArtemkaKun/v-project-basement][30] served as a base for CI scripts and issue templates
[10]: https://github.com/Waqar144/progressbar
[20]: https://github.com/console-rs/indicatif
[30]: https://github.com/ArtemkaKun/v-project-basement