infinite

package module
v0.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 20, 2023 License: MIT Imports: 7 Imported by: 9

README

infinite

用于开发交互式 CLI(tui,terminal) 程序的组件库.
go report card release
demo

中文 | English

Features

  • 提供一系列开箱即用的组件
    • autocomplete
    • progress-bar group
    • multi/single select
    • spinner
    • confirm(input/selection)
    • input text
  • 跨平台
  • 可定制,你可以替换组件中的某些选项或方法为你自己的实现
    • 通过修改 multi select某些选项 实现 single select
  • 可组合,你可以将一个或多个基础组件联合在一起使用
    • autocomplete 通过 input 来实现输入接收,通过 selection 来实现待选项的选择.
    • selection 通过嵌入 input 来实现过滤功能.

Install

go get github.com/fzdwx/infinite

Getting started

https://fzdwx.github.io/infinite/zh/guide/getting-started

Examples

https://fzdwx.github.io/infinite/zh/guide/examples

Documentation

https://fzdwx.github.io/infinite/

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewConfirm

func NewConfirm(ops ...confirm.Option) *confirm.Confirm

NewConfirm new confirm

func NewConfirmWithSelection added in v0.6.1

func NewConfirmWithSelection(ops ...cs.Option) *cs.Confirm

NewConfirmWithSelection new confirm with Selection

func NewMultiSelect

func NewMultiSelect(choices []string, ops ...multiselect.Option) *multiselect.Select

NewMultiSelect new multi select

func NewProgressGroup added in v0.5.1

func NewProgressGroup(processCnt int) *progress.Group

NewProgressGroup new progress group with count.

func NewSingleSelect

func NewSingleSelect(choices []string, ops ...singleselect.Option) *singleselect.Select

NewSingleSelect new single select

func NewSpinner

func NewSpinner(ops ...spinner.Option) *spinner.Spinner

NewSpinner new spinner

func NewText

func NewText(ops ...text.Option) *text.Text

NewText new text input

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL