singleselect

Documentation

Index

• type KeyMap
  • func DefaultSingleKeyMap() KeyMap
• type Option
  • func WithChoiceTextStyle(style *style.Style) Option
  • func WithCursorSymbol(symbol string) Option
  • func WithCursorSymbolStyle(style *style.Style) Option
  • func WithDisableFilter() Option
  • func WithDisableHelp() Option
  • func WithDisableOutputResult() Option
  • func WithFilterFunc(...) Option
  • func WithFilterInput(input *components.Input) Option
  • func WithFocusInterval(ss string) Option
  • func WithFocusIntervalStyle(stl *style.Style) Option
  • func WithFocusSymbol(ss string) Option
  • func WithFocusSymbolStyle(stl *style.Style) Option
  • func WithHiddenPaginator() Option
  • func WithKeyBinding(keymap KeyMap) Option
  • func WithPageSize(pageSize int) Option
  • func WithPaginator(pager paginator.Model) Option
  • func WithPrompt(prompt ...string) Option
  • func WithPromptStyle(style *style.Style) Option
  • func WithRowRender(rowRender func(string, string, string) string) Option
  • func WithUnFocusInterval(ss string) Option
  • func WithUnFocusIntervalStyle(stl *style.Style) Option
  • func WithUnFocusSymbol(ss string) Option
  • func WithUnFocusSymbolStyle(stl *style.Style) Option
  • func WithValueStyle(stl *style.Style) Option
• type Select
  • func New(choices []string, ops ...Option) *Select
  • func (s *Select) Apply(ops ...Option) *Select
  • func (s *Select) Display(prompt ...string) (int, error)

Types

type KeyMap

type KeyMap struct {
	Up       key.Binding
	Down     key.Binding
	Choice   key.Binding
	Confirm  key.Binding
	Quit     key.Binding
	NextPage key.Binding
	PrevPage key.Binding
}

func DefaultSingleKeyMap

func DefaultSingleKeyMap() KeyMap

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 WithDisableHelp

func WithDisableHelp() Option

WithDisableHelp disable show help.

func WithDisableOutputResult

func WithDisableOutputResult() Option

WithDisableOutputResult disable output result.

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

func WithFocusInterval(ss string) Option

WithFocusInterval default is theme.DefaultTheme#FocusInterval:

func WithFocusIntervalStyle

func WithFocusIntervalStyle(stl *style.Style) Option

WithFocusIntervalStyle default is theme.DefaultTheme#FocusIntervalStyle:

func WithFocusSymbol

func WithFocusSymbol(ss string) Option

WithFocusSymbol default is theme.DefaultTheme#FocusSymbol:

func WithFocusSymbolStyle

func WithFocusSymbolStyle(stl *style.Style) Option

WithFocusSymbolStyle default is theme.DefaultTheme#FocusSymbolStyle:

func WithHiddenPaginator

func WithHiddenPaginator() Option

WithHiddenPaginator hidden paginator view.

func WithKeyBinding

func WithKeyBinding(keymap KeyMap) Option

WithKeyBinding replace key map. see DefaultSingleKeyMap

func WithPageSize

func WithPageSize(pageSize int) Option

WithPageSize default is 5

func WithPaginator

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

func WithUnFocusInterval(ss string) Option

WithUnFocusInterval default is theme.DefaultTheme#UnFocusInterval:

func WithUnFocusIntervalStyle

func WithUnFocusIntervalStyle(stl *style.Style) Option

WithUnFocusIntervalStyle default is theme.DefaultTheme#UnFocusIntervalStyle:

func WithUnFocusSymbol

func WithUnFocusSymbol(ss string) Option

WithUnFocusSymbol default is theme.DefaultTheme#UnFocusSymbol:

func WithUnFocusSymbolStyle

func WithUnFocusSymbolStyle(stl *style.Style) Option

WithUnFocusSymbolStyle default is theme.DefaultTheme#UnFocusSymbolStyle:

func WithValueStyle

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

New single Select

func (*Select) Apply

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

Apply options on Select

func (*Select) Display

func (s *Select) Display(prompt ...string) (int, error)

Display startup Select