TTY::Spinner 使用教程

TTY::Spinner 使用教程

tty-spinnerA terminal spinner for tasks that have non-deterministic time frame.项目地址:https://gitcode.com/gh_mirrors/tt/tty-spinner

1、项目介绍

TTY::Spinner 是一个用于 Ruby 编程语言的终端旋转器库，适用于那些无法确定完成时间的任务。它可以在终端中显示一个旋转动画，以指示后台任务正在进行中。TTY::Spinner 提供了多种格式和配置选项，使得开发者可以根据需要自定义旋转器的外观和行为。

2、项目快速启动

安装

首先，在你的 Gemfile 中添加以下行：

gem "tty-spinner"

然后执行：

$ bundle

或者手动安装：

$ gem install tty-spinner

基本使用

以下是一个简单的示例，展示如何在终端中使用 TTY::Spinner：

require "tty-spinner"

spinner = TTY::Spinner.new("[:spinner] Loading ...", format: :pulse_2)
spinner.auto_spin # 自动动画，默认间隔时间

sleep(2) # 模拟任务执行

spinner.stop("Done") # 停止动画并输出完成信息

运行上述代码后，终端将显示如下动画：

⎺ Loading ...

任务完成后，输出：

_ Loading ... Done

3、应用案例和最佳实践

同步多个旋转器

TTY::Spinner 还支持同步多个旋转器，适用于需要同时显示多个任务进度的情况。以下是一个示例：

require "tty-spinner"

spinners = TTY::Spinner::Multi.new("[:spinner] top")

sp1 = spinners.register("[:spinner] one")
sp2 = spinners.register("[:spinner] two")

sp1.auto_spin
sp2.auto_spin

sleep(2) # 模拟任务执行

sp1.success
sp2.success

运行上述代码后，终端将显示如下动画：

┌ [✔] top
├── [✔] one
└── [✔] two

自定义格式和配置

TTY::Spinner 提供了多种格式和配置选项，可以根据需要自定义旋转器的外观和行为。以下是一个示例：

spinner = TTY::Spinner.new("[:spinner] Loading ...", format: :pulse_2, interval: 80)
spinner.auto_spin

sleep(2) # 模拟任务执行

spinner.stop("Done")

4、典型生态项目

TTY::Spinner 是 TTY 工具包的一部分，该工具包包含多个用于终端应用的组件。以下是一些相关的生态项目：

• TTY::Prompt: 一个用于创建交互式命令行应用程序的库。
• TTY::Command: 一个用于执行外部命令并捕获其输出的库。
• TTY::Table: 一个用于在终端中显示表格数据的库。

这些项目共同构成了一个强大的终端应用开发工具集，适用于各种命令行工具的开发。

---

通过以上内容，你应该能够快速上手并使用 TTY::Spinner 来增强你的终端应用程序的用户体验。

tty-spinnerA terminal spinner for tasks that have non-deterministic time frame.项目地址:https://gitcode.com/gh_mirrors/tt/tty-spinner