box

README

Go-Box - Interactive item selector

box - Executable

• box reads choices from STDIN,
• On box, the user selects one by cursor (HJKL , C-n & C-p & C-f & C-b)
• box outputs chosen one to STDOUT.

Install

Download the binary package from Releases and extract the executable.

Use "go install"

go install github.com/nyaosorg/go-box/v2/cmd/box@latest

Use "scoop-installer"

scoop install https://raw.githubusercontent.com/nyaosorg/go-box/master/box.json

or

scoop bucket add hymkor https://github.com/hymkor/scoop-bucket
scoop install box

go-box - golang package

package main

import (
    "os"

    "github.com/nyaosorg/go-box/v2"
)

func main() {
    println("Are you sure ?")
    choose, err := box.SelectString([]string{"Yes", "No"}, false, os.Stderr)
    if err != nil {
        println(err.Error())
        os.Exit(1)
    }
    println()
    if len(choose) >= 1 {
        println("You selected ->", choose[0])
    } else {
        println("You did not select any items")
    }
}

Documentation

Index

• Variables
• func Choice(sources []string, out io.Writer) string
• func ChoiceMulti(sources []string, out io.Writer) []string
• func Choose(sources []string, out io.Writer) int
• func ChooseMulti(sources []string, out io.Writer) []int
• func Print(ctx context.Context, nodes []string, out io.Writer) bool
• func PrintNoLastLineFeed(ctx context.Context, nodes []string, offset int, out io.Writer) (bool, int, int)
• func PrintX(ctx context.Context, nodes []string, out io.Writer) error
• func SelectIndex(sources []string, multi bool, out io.Writer) ([]int, error)
• func SelectIndexContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]int, error)
• func SelectString(sources []string, multi bool, out io.Writer) ([]string, error)
• func SelectStringContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]string, error)
• type Box
  • func New() *Box
  • func NewBox() (*Box, error)
  • func (b *Box) Close() error
  • func (b *Box) Print(ctx context.Context, nodes []string, offset int, out io.Writer) (bool, int, int)
  • func (b *Box) PrintNoLastLineFeed(ctx context.Context, nodes []string, offset int, out io.Writer) (bool, int, int)
  • func (b *Box) PrintNoLastLineFeedX(ctx context.Context, nodes []string, offset int, out io.Writer) (int, int, error)
  • func (b *Box) PrintX(ctx context.Context, nodes []string, offset int, out io.Writer) (int, int, error)
  • func (b *Box) SelectIndex(sources []string, multi bool, out io.Writer) ([]int, error)
  • func (b *Box) SelectIndexContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]int, error)
  • func (b *Box) SelectString(sources []string, multi bool, out io.Writer) ([]string, error)
  • func (b *Box) SelectStringContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]string, error)
• type BoxT

Variables

var AnsiCutter = regexp.MustCompile("\x1B[^a-zA-Z]*[A-Za-z]")

Functions

func Choice

func Choice(sources []string, out io.Writer) string

Deprecated: Choice returns returns the string that user selected.

func ChoiceMulti

func ChoiceMulti(sources []string, out io.Writer) []string

Deprecated: ChoiceMulti returns the strings that user selected.

func Choose

func Choose(sources []string, out io.Writer) int

Deprecated: Choose returns the index that user selected

func ChooseMulti

func ChooseMulti(sources []string, out io.Writer) []int

Deprecated: Choose Multi returns the indices that user selected.

func Print

func Print(ctx context.Context, nodes []string, out io.Writer) bool

Deprecated:

func PrintNoLastLineFeed

func PrintNoLastLineFeed(ctx context.Context,
	nodes []string,
	offset int,
	out io.Writer) (bool, int, int)

Deprecated:

func PrintX

func PrintX(ctx context.Context, nodes []string, out io.Writer) error

PrintX outputs items in a tabular format

func SelectIndex

func SelectIndex(sources []string, multi bool, out io.Writer) ([]int, error)

SelectIndex returns the indexes that user selected.

func SelectIndexContext

func SelectIndexContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]int, error)

func SelectString

func SelectString(sources []string, multi bool, out io.Writer) ([]string, error)

SelectString returns the strings that user selected.

func SelectStringContext

func SelectStringContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]string, error)

Types

type Box

type Box struct {
	// contains filtered or unexported fields
}

func New

func New() *Box

Deprecated:

func NewBox

func NewBox() (*Box, error)

func (*Box) Close

func (b *Box) Close() error

func (*Box) Print

func (b *Box) Print(ctx context.Context,
	nodes []string,
	offset int,
	out io.Writer) (bool, int, int)

Deprecated:

func (*Box) PrintNoLastLineFeed

func (b *Box) PrintNoLastLineFeed(ctx context.Context,
	nodes []string,
	offset int,
	out io.Writer) (bool, int, int)

Deprecated:

func (*Box) PrintNoLastLineFeedX

func (b *Box) PrintNoLastLineFeedX(ctx context.Context,
	nodes []string,
	offset int,
	out io.Writer) (int, int, error)

PrintNoLastLineFeedX outputs items in a tabular format, but removes the last line feed

func (*Box) PrintX

func (b *Box) PrintX(ctx context.Context,
	nodes []string,
	offset int,
	out io.Writer) (int, int, error)

PrintX outputs items in a tabular format

func (*Box) SelectIndex

func (b *Box) SelectIndex(sources []string, multi bool, out io.Writer) ([]int, error)

SelectIndex returns the indexes that user selected.

func (*Box) SelectIndexContext

func (b *Box) SelectIndexContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]int, error)

func (*Box) SelectString

func (b *Box) SelectString(sources []string, multi bool, out io.Writer) ([]string, error)

SelectString returns the strings that user selected.

func (*Box) SelectStringContext

func (b *Box) SelectStringContext(ctx context.Context, sources []string, multi bool, out io.Writer) ([]string, error)

type BoxT

type BoxT = Box

Deprecated: