zhangyiss/indicators
1
0
Fork 0
mirror of https://github.com/p-ranav/indicators.git synced 2025-12-15 11:58:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Pranav
2019-12-17 21:33:22 -06:00
committed by GitHub
parent 5eb8cc5f91
commit 45ad6da847
1 changed files with 5 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -412,27 +412,7 @@ int main() {
# Progress Spinner # Progress Spinner
To introduce a progress spinner in your application, include `indicators/progress_spinner.hpp` and create a `ProgressSpinner` object. To introduce a progress spinner in your application, include `indicators/progress_spinner.hpp` and create a `ProgressSpinner` object. Here's the general structure of a progress spinner:
```cpp
#include <indicators/progress_spinner.hpp>
int main() {
indicators::ProgressSpinner spinner;
// Configure the spinner
spinner.set_prefix_text(" ");
spinner.set_postfix_text("Checking credentials");
spinner.set_foreground_color(indicators::Color::YELLOW);
spinner.set_spinner_states({"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"});
// Update spinner state
return 0;
}
```
Here's the general structure of a progress spinner:
``` ```
{prefix} {spinner} {percentage} [{elapsed}<{remaining}] {postfix} {prefix} {spinner} {percentage} [{elapsed}<{remaining}] {postfix}
@@ -440,6 +420,10 @@ Here's the general structure of a progress spinner:
ProgressSpinner has a vector of strings: `spinner_states`. At each update, the spinner will pick the next string from this sequence to print to the console. The spinner state can be updated similarly to ProgressBars: Using either `tick()` or `set_progress(value)`. ProgressSpinner has a vector of strings: `spinner_states`. At each update, the spinner will pick the next string from this sequence to print to the console. The spinner state can be updated similarly to ProgressBars: Using either `tick()` or `set_progress(value)`.
<p align="center">
<img src="img/progress_spinner.gif"/>
</p>
```cpp ```cpp
#include <indicators/progress_spinner.hpp> #include <indicators/progress_spinner.hpp>