Project Icon

spinner

Go语言实现的终端进度指示器和加载动画库

Spinner是一个Go语言开发的终端动画库,提供90种字符集用于创建加载动画和进度指示器。该库支持自定义动画速度、颜色和文本属性,允许启动、停止和重启动画,添加前缀后缀文本,以及输出最终状态。Spinner主要用于CLI应用程序中展示长时间运行任务的进度,为终端界面增添动态效果。

加载指示器

GoDoc CircleCI

spinner是一个简单的包,用于在任何终端应用程序中添加加载指示器/进度指示器。下面可以找到示例,完整示例在examples目录中。

有关库及其功能的更多详细信息,安装后请参考本地godoc。

欢迎贡献!

安装

go get github.com/briandowns/spinner

可用字符集

90个字符集。以下是一些示例:

(按其切片索引编号)

索引字符集示例动图
0←↖↑↗→↘↓↙示例动图
1▁▃▄▅▆▇█▇▆▅▄▃▁示例动图
2▖▘▝▗示例动图
3┤┘┴└├┌┬┐示例动图
4◢◣◤◥示例动图
5◰◳◲◱示例动图
6◴◷◶◵示例动图
7◐◓◑◒示例动图
8.oO@*示例动图
9|/-\示例动图
10◡◡⊙⊙◠◠示例动图
11⣾⣽⣻⢿⡿⣟⣯⣷示例动图
12>))'> >))'> >))'> >))'> >))'> <'((< <'((< <'((<示例动图
13⠁⠂⠄⡀⢀⠠⠐⠈示例动图
14⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏示例动图
15abcdefghijklmnopqrstuvwxyz示例动图
16▉▊▋▌▍▎▏▎▍▌▋▊▉示例动图
17■□▪▫示例动图
18←↑→↓示例动图
19╫╪示例动图
20⇐⇖⇑⇗⇒⇘⇓⇙示例动图
21⠁⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈⠈示例动图
22⠈⠉⠋⠓⠒⠐⠐⠒⠖⠦⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈示例动图
23⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠴⠲⠒⠂⠂⠒⠚⠙⠉⠁示例动图
24⠋⠙⠚⠒⠂⠂⠒⠲⠴⠦⠖⠒⠐⠐⠒⠓⠋示例动图
25ヲァィゥェォャュョッアイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワン示例动图
26. .. ...示例动图
27▁▂▃▄▅▆▇█▉▊▋▌▍▎▏▏▎▍▌▋▊▉█▇▆▅▄▃▂▁示例动图
28.oO°Oo.示例动图
29+x示例动图
30v<^>示例动图
31>>---> >>---> >>---> >>---> >>---> <---<< <---<< <---<< <---<< <---<<示例动图
32| || ||| |||| ||||| |||||| ||||| |||| ||| || |示例动图
33[] [=] [==] [===] [====] [=====] [======] [=======] [========] [=========] [==========]示例动图
34(*---------) (-*--------) (--*-------) (---*------) (----*-----) (-----*----) (------*---) (-------*--) (--------*-) (---------*)示例动图
35█▒▒▒▒▒▒▒▒▒ ███▒▒▒▒▒▒▒ █████▒▒▒▒▒ ███████▒▒▒ ██████████示例动图
36[ ] [=> ] [===> ] [=====> ] [======> ] [========> ] [==========> ] [============> ] [==============> ] [================> ] [==================> ] [===================>]示例动图
37🕐 🕑 🕒 🕓 🕔 🕕 🕖 🕗 🕘 🕙 🕚 🕛示例动图
38🕐 🕜 🕑 🕝 🕒 🕞 🕓 🕟 🕔 🕠 🕕 🕡 🕖 🕢 🕗 🕣 🕘 🕤 🕙 🕥 🕚 🕦 🕛 🕧示例动图
39🌍 🌎 🌏示例动图
40◜ ◝ ◞ ◟示例动图
41⬒ ⬔ ⬓ ⬕示例动图
42⬖ ⬘ ⬗ ⬙示例动图
43[>>> >] []>>>> [] [] >>>> [] [] >>>> [] [] >>>> [] [] >>>>[] [>> >>]示例动图

特性

  • 启动
  • 停止
  • 重启
  • 反向旋转
  • 更新旋转器字符集
  • 更新旋转速度
  • 前缀或附加文本
  • 更改旋转器颜色、背景和文本属性如粗体/斜体
  • 获取旋转器状态
  • 链接、管道、重定向输出
  • 在旋转器/指示器完成时输出最终字符串

示例

package main

import (
	"github.com/briandowns/spinner"
	"time"
)

func main() {
	s := spinner.New(spinner.CharSets[9], 100*time.Millisecond)  // 构建新的旋转器
	s.Start()                                                    // 启动旋转器
	time.Sleep(4 * time.Second)                                  // 运行一段时间来模拟工作
	s.Stop()
}

更新字符集并重启旋转器

s.UpdateCharSet(spinner.CharSets[1])  // 更新旋转器以使用不同的字符集
s.Restart()                           // 重启旋转器
time.Sleep(4 * time.Second)
s.Stop()

更新旋转速度并重启旋转器

s.UpdateSpeed(200 * time.Millisecond) // 更新旋转器的旋转速度
s.Restart()
time.Sleep(4 * time.Second)
s.Stop()

反转旋转器的方向

s.Reverse() // 反转旋转器的旋转方向
s.Restart()
time.Sleep(4 * time.Second)
s.Stop()

提供自己的旋转器

(或向我提交问题或拉取请求以添加到项目中)

someSet := []string{"+", "-"}
s := spinner.New(someSet, 100*time.Millisecond)

在旋转器前缀或附加文本

s.Prefix = "前缀文本: " // 在旋转器之前添加前缀文本
s.Suffix = "  :附加文本" // 在旋转器之后附加文本

设置或更改旋转器的颜色。默认颜色为白色。需要重启旋转器以应用更改。

s.Color("red") // 将旋转器颜色设置为红色

您可以同时指定背景色和前景色,以及其他属性如boldunderline

s.Color("red", "bold") // 将旋转器颜色设置为粗体红色

要将背景设置为黑色,前景设置为粗体红色:

s.Color("bgBlack", "bold", "fgRed")

以下是完整的颜色和属性列表:

// 默认颜色
red
black
green
yellow
blue
magenta
cyan
white

// 属性
reset
bold
faint
italic
underline
blinkslow
blinkrapid
reversevideo
concealed
crossedout

// 前景文本
fgBlack
fgRed
fgGreen
fgYellow
fgBlue
fgMagenta
fgCyan
fgWhite

// 前景高强度文本
fgHiBlack
fgHiRed
fgHiGreen
fgHiYellow
fgHiBlue
fgHiMagenta
fgHiCyan
fgHiWhite

// 背景文本
bgBlack
bgRed
bgGreen
bgYellow
bgBlue
bgMagenta
bgCyan
bgWhite

// 背景高强度文本
bgHiBlack
bgHiRed
bgHiGreen
bgHiYellow
bgHiBlue
bgHiMagenta
bgHiCyan
bgHiWhite

生成数字序列

setOfDigits := spinner.GenerateNumberSequence(25)    // 生成25位数字字符串
s := spinner.New(setOfDigits, 100*time.Millisecond)

获取旋转器状态

fmt.Println(s.Active())

Unix管道和重定向

dekz建议并撰写的功能

将Spinner Writer设置为Stderr有助于向用户显示进度,并增强了链接、管道或重定向输出的功能。

这是当前设置Writer的首选方法。

s := spinner.New(spinner.CharSets[11], 100*time.Millisecond, spinner.WithWriter(os.Stderr))
s.Suffix = " 正在加密数据..."
s.Start()
// 将数据加密为密文
fmt.Println(os.Stdout, ciphertext)
> myprog encrypt "Secret text" > encrypted.txt
⣯ 正在加密数据...
> cat encrypted.txt
1243hjkbas23i9ah27sj39jghv237n2oa93hg83

最终字符串输出

在旋转器/指示器完成时添加额外输出。"最终"输出字符串可以是多行的,并将写入配置的io.Writer

s := spinner.New(spinner.CharSets[9], 100*time.Millisecond)
s.FinalMSG = "完成!\n新行!\n再一行!\n"
s.Start()                 
time.Sleep(4 * time.Second)
s.Stop()                   

输出

完成!
新行!
再一行!
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号