multiselect

package
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: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Option

type Option func(s *Select)

Option the option of Select

func WithChoiceTextStyle

func WithChoiceTextStyle(style *style.Style) Option

WithChoiceTextStyle default is theme.DefaultTheme.ChoiceTextStyle.

func WithCursorSymbol

func WithCursorSymbol(symbol string) Option

WithCursorSymbol default is ">"

func WithCursorSymbolStyle

func WithCursorSymbolStyle(style *style.Style) Option

WithCursorSymbolStyle default is theme.DefaultTheme.CursorSymbolStyle.

func WithDisableFilter

func WithDisableFilter() Option

WithDisableFilter disable filter.

func WithDisableOutputResult

func WithDisableOutputResult() Option

WithDisableOutputResult disable output result.

func WithDisableShowHelp added in v0.10.0

func WithDisableShowHelp() Option

WithDisableShowHelp disable show help.

func WithFilterFunc

func WithFilterFunc(f func(input string, items []components.SelectionItem) []components.SelectionItem) Option

WithFilterFunc replace filter func.

func WithFilterInput

func WithFilterInput(input *components.Input) Option

WithFilterInput replace filter input.

func WithFocusInterval added in v0.8.1

func WithFocusInterval(ss string) Option

WithFocusInterval default is theme.DefaultTheme#FocusInterval:

func WithFocusIntervalStyle added in v0.8.1

func WithFocusIntervalStyle(stl *style.Style) Option

WithFocusIntervalStyle default is theme.DefaultTheme#FocusIntervalStyle:

func WithFocusSymbol added in v0.8.1

func WithFocusSymbol(ss string) Option

WithFocusSymbol default is theme.DefaultTheme#FocusSymbol:

func WithFocusSymbolStyle added in v0.8.1

func WithFocusSymbolStyle(stl *style.Style) Option

WithFocusSymbolStyle default is theme.DefaultTheme#FocusSymbolStyle:

func WithHeader added in v0.10.0

func WithHeader(header string) Option

WithHeader default is ""

func WithHiddenPaginator added in v0.12.0

func WithHiddenPaginator() Option

WithHiddenPaginator hidden paginator view.

func WithHintSymbol

func WithHintSymbol(selectedStr string) Option

WithHintSymbol default is "✓".

func WithHintSymbolStyle

func WithHintSymbolStyle(style *style.Style) Option

WithHintSymbolStyle default is Theme.MultiSelectedHintSymbolStyle.

func WithKeyMap added in v0.7.5

func WithKeyMap(keymap components.SelectionKeyMap) Option

WithKeyMap replace key map. see components.DefaultMultiKeyMap

example:

keymap := components.DefaultMultiKeyMap()

keymap.Choice = key.NewBinding(

key.WithKeys(tea.KeySpace.String()),

)

func WithPageSize

func WithPageSize(pageSize int) Option

WithPageSize default is 5

func WithPaginator added in v0.12.0

func WithPaginator(pager paginator.Model) Option

WithPaginator set paginator.

func WithPrompt

func WithPrompt(prompt ...string) Option

WithPrompt default is "Please selection your options:"

func WithPromptStyle

func WithPromptStyle(style *style.Style) Option

WithPromptStyle default is Theme.PromptStyle.

func WithRowRender

func WithRowRender(rowRender func(string, string, string) string) Option

WithRowRender default is

` fmt.Sprintf("%s [%s] %s", cursorSymbol, hintSymbol, choice) `

func WithUnFocusInterval added in v0.8.1

func WithUnFocusInterval(ss string) Option

WithUnFocusInterval default is theme.DefaultTheme#UnFocusInterval:

func WithUnFocusIntervalStyle added in v0.8.1

func WithUnFocusIntervalStyle(stl *style.Style) Option

WithUnFocusIntervalStyle default is theme.DefaultTheme#UnFocusIntervalStyle:

func WithUnFocusSymbol added in v0.8.1

func WithUnFocusSymbol(ss string) Option

WithUnFocusSymbol default is theme.DefaultTheme#UnFocusSymbol:

func WithUnFocusSymbolStyle added in v0.8.1

func WithUnFocusSymbolStyle(stl *style.Style) Option

WithUnFocusSymbolStyle default is theme.DefaultTheme#UnFocusSymbolStyle:

func WithUnHintSymbol

func WithUnHintSymbol(unSelectedStr string) Option

WithUnHintSymbol default is "✗".

func WithUnHintSymbolStyle

func WithUnHintSymbolStyle(style *style.Style) Option

WithUnHintSymbolStyle default is Theme.UnHintSymbolStyle.

func WithValidator added in v0.10.0

func WithValidator(v components.Validator) Option

WithValidator specifies a validator to use while prompting the user

func WithValueStyle added in v0.8.1

func WithValueStyle(stl *style.Style) Option

WithValueStyle default is theme.DefaultTheme#ChoiceTextStyle.Underline()

type Select

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

func New

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

func (*Select) Apply

func (ms *Select) Apply(ops ...Option) *Select

Apply options on Select

func (*Select) Display

func (ms *Select) Display(prompt ...string) ([]int, error)

Display startup Select

Jump to

Keyboard shortcuts

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