1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
package pterm
import (
"fmt"
"sort"
"atomicgo.dev/cursor"
"atomicgo.dev/keyboard"
"atomicgo.dev/keyboard/keys"
"github.com/lithammer/fuzzysearch/fuzzy"
"github.com/pterm/pterm/internal"
)
var (
// DefaultInteractiveMultiselect is the default InteractiveMultiselect printer.
DefaultInteractiveMultiselect = InteractiveMultiselectPrinter{
TextStyle: &ThemeDefault.PrimaryStyle,
DefaultText: "Please select your options",
Options: []string{},
OptionStyle: &ThemeDefault.DefaultText,
DefaultOptions: []string{},
MaxHeight: 5,
Selector: ">",
SelectorStyle: &ThemeDefault.SecondaryStyle,
Filter: true,
KeySelect: keys.Enter,
KeyConfirm: keys.Tab,
Checkmark: &ThemeDefault.Checkmark,
}
)
// InteractiveMultiselectPrinter is a printer for interactive multiselect menus.
type InteractiveMultiselectPrinter struct {
DefaultText string
TextStyle *Style
Options []string
OptionStyle *Style
DefaultOptions []string
MaxHeight int
Selector string
SelectorStyle *Style
Filter bool
Checkmark *Checkmark
OnInterruptFunc func()
selectedOption int
selectedOptions []int
text string
fuzzySearchString string
fuzzySearchMatches []string
displayedOptions []string
displayedOptionsStart int
displayedOptionsEnd int
// KeySelect is the select key. It cannot be keys.Space when Filter is enabled.
KeySelect keys.KeyCode
// KeyConfirm is the confirm key. It cannot be keys.Space when Filter is enabled.
KeyConfirm keys.KeyCode
}
// WithOptions sets the options.
func (p InteractiveMultiselectPrinter) WithOptions(options []string) *InteractiveMultiselectPrinter {
p.Options = options
return &p
}
// WithDefaultOptions sets the default options.
func (p InteractiveMultiselectPrinter) WithDefaultOptions(options []string) *InteractiveMultiselectPrinter {
p.DefaultOptions = options
return &p
}
// WithDefaultText sets the default text.
func (p InteractiveMultiselectPrinter) WithDefaultText(text string) *InteractiveMultiselectPrinter {
p.DefaultText = text
return &p
}
// WithMaxHeight sets the maximum height of the select menu.
func (p InteractiveMultiselectPrinter) WithMaxHeight(maxHeight int) *InteractiveMultiselectPrinter {
p.MaxHeight = maxHeight
return &p
}
// WithFilter sets the Filter option
func (p InteractiveMultiselectPrinter) WithFilter(b ...bool) *InteractiveMultiselectPrinter {
p.Filter = internal.WithBoolean(b)
return &p
}
// WithKeySelect sets the confirm key
// It cannot be keys.Space when Filter is enabled.
func (p InteractiveMultiselectPrinter) WithKeySelect(keySelect keys.KeyCode) *InteractiveMultiselectPrinter {
p.KeySelect = keySelect
return &p
}
// WithKeyConfirm sets the confirm key
// It cannot be keys.Space when Filter is enabled.
func (p InteractiveMultiselectPrinter) WithKeyConfirm(keyConfirm keys.KeyCode) *InteractiveMultiselectPrinter {
p.KeyConfirm = keyConfirm
return &p
}
// WithCheckmark sets the checkmark
func (p InteractiveMultiselectPrinter) WithCheckmark(checkmark *Checkmark) *InteractiveMultiselectPrinter {
p.Checkmark = checkmark
return &p
}
// OnInterrupt sets the function to execute on exit of the input reader
func (p InteractiveMultiselectPrinter) WithOnInterruptFunc(exitFunc func()) *InteractiveMultiselectPrinter {
p.OnInterruptFunc = exitFunc
return &p
}
// Show shows the interactive multiselect menu and returns the selected entry.
func (p *InteractiveMultiselectPrinter) Show(text ...string) ([]string, error) {
// should be the first defer statement to make sure it is executed last
// and all the needed cleanup can be done before
cancel, exit := internal.NewCancelationSignal(p.OnInterruptFunc)
defer exit()
if len(text) == 0 || Sprint(text[0]) == "" {
text = []string{p.DefaultText}
}
p.text = p.TextStyle.Sprint(text[0])
p.fuzzySearchMatches = append([]string{}, p.Options...)
if p.MaxHeight == 0 {
p.MaxHeight = DefaultInteractiveMultiselect.MaxHeight
}
maxHeight := p.MaxHeight
if maxHeight > len(p.fuzzySearchMatches) {
maxHeight = len(p.fuzzySearchMatches)
}
if len(p.Options) == 0 {
return nil, fmt.Errorf("no options provided")
}
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[:maxHeight]...)
p.displayedOptionsStart = 0
p.displayedOptionsEnd = maxHeight
for _, option := range p.DefaultOptions {
p.selectOption(option)
}
area, err := DefaultArea.Start(p.renderSelectMenu())
defer area.Stop()
if err != nil {
return nil, fmt.Errorf("could not start area: %w", err)
}
if p.Filter && (p.KeyConfirm == keys.Space || p.KeySelect == keys.Space) {
return nil, fmt.Errorf("if filter/search is active, keys.Space can not be used for KeySelect or KeyConfirm")
}
area.Update(p.renderSelectMenu())
cursor.Hide()
defer cursor.Show()
err = keyboard.Listen(func(keyInfo keys.Key) (stop bool, err error) {
key := keyInfo.Code
if p.MaxHeight > len(p.fuzzySearchMatches) {
maxHeight = len(p.fuzzySearchMatches)
} else {
maxHeight = p.MaxHeight
}
switch key {
case p.KeyConfirm:
if len(p.fuzzySearchMatches) == 0 {
return false, nil
}
area.Update(p.renderFinishedMenu())
return true, nil
case p.KeySelect:
if len(p.fuzzySearchMatches) > 0 {
// Select option if not already selected
p.selectOption(p.fuzzySearchMatches[p.selectedOption])
}
area.Update(p.renderSelectMenu())
case keys.RuneKey:
if p.Filter {
// Fuzzy search for options
// append to fuzzy search string
p.fuzzySearchString += keyInfo.String()
p.selectedOption = 0
p.displayedOptionsStart = 0
p.displayedOptionsEnd = maxHeight
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[:maxHeight]...)
}
area.Update(p.renderSelectMenu())
case keys.Space:
if p.Filter {
p.fuzzySearchString += " "
p.selectedOption = 0
area.Update(p.renderSelectMenu())
}
case keys.Backspace:
// Remove last character from fuzzy search string
if p.fuzzySearchString != "" {
// Handle UTF-8 characters
p.fuzzySearchString = string([]rune(p.fuzzySearchString)[:len([]rune(p.fuzzySearchString))-1])
}
if p.fuzzySearchString == "" {
p.fuzzySearchMatches = append([]string{}, p.Options...)
}
p.renderSelectMenu()
if len(p.fuzzySearchMatches) > p.MaxHeight {
maxHeight = p.MaxHeight
} else {
maxHeight = len(p.fuzzySearchMatches)
}
p.selectedOption = 0
p.displayedOptionsStart = 0
p.displayedOptionsEnd = maxHeight
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[p.displayedOptionsStart:p.displayedOptionsEnd]...)
area.Update(p.renderSelectMenu())
case keys.Left:
// Unselect all options
p.selectedOptions = []int{}
area.Update(p.renderSelectMenu())
case keys.Right:
// Select all options
p.selectedOptions = []int{}
for i := 0; i < len(p.Options); i++ {
p.selectedOptions = append(p.selectedOptions, i)
}
area.Update(p.renderSelectMenu())
case keys.Up, keys.CtrlP:
if len(p.fuzzySearchMatches) == 0 {
return false, nil
}
if p.selectedOption > 0 {
p.selectedOption--
if p.selectedOption < p.displayedOptionsStart {
p.displayedOptionsStart--
p.displayedOptionsEnd--
if p.displayedOptionsStart < 0 {
p.displayedOptionsStart = 0
p.displayedOptionsEnd = maxHeight
}
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[p.displayedOptionsStart:p.displayedOptionsEnd]...)
}
} else {
p.selectedOption = len(p.fuzzySearchMatches) - 1
p.displayedOptionsStart = len(p.fuzzySearchMatches) - maxHeight
p.displayedOptionsEnd = len(p.fuzzySearchMatches)
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[p.displayedOptionsStart:p.displayedOptionsEnd]...)
}
area.Update(p.renderSelectMenu())
case keys.Down, keys.CtrlN:
if len(p.fuzzySearchMatches) == 0 {
return false, nil
}
p.displayedOptions = p.fuzzySearchMatches[:maxHeight]
if p.selectedOption < len(p.fuzzySearchMatches)-1 {
p.selectedOption++
if p.selectedOption >= p.displayedOptionsEnd {
p.displayedOptionsStart++
p.displayedOptionsEnd++
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[p.displayedOptionsStart:p.displayedOptionsEnd]...)
}
} else {
p.selectedOption = 0
p.displayedOptionsStart = 0
p.displayedOptionsEnd = maxHeight
p.displayedOptions = append([]string{}, p.fuzzySearchMatches[p.displayedOptionsStart:p.displayedOptionsEnd]...)
}
area.Update(p.renderSelectMenu())
case keys.CtrlC:
cancel()
return true, nil
}
return false, nil
})
if err != nil {
Error.Println(err)
return nil, fmt.Errorf("failed to start keyboard listener: %w", err)
}
var result []string
for _, selectedOption := range p.selectedOptions {
result = append(result, p.Options[selectedOption])
}
return result, nil
}
func (p InteractiveMultiselectPrinter) findOptionByText(text string) int {
for i, option := range p.Options {
if option == text {
return i
}
}
return -1
}
func (p *InteractiveMultiselectPrinter) isSelected(optionText string) bool {
for _, selectedOption := range p.selectedOptions {
if p.Options[selectedOption] == optionText {
return true
}
}
return false
}
func (p *InteractiveMultiselectPrinter) selectOption(optionText string) {
if p.isSelected(optionText) {
// Remove from selected options
for i, selectedOption := range p.selectedOptions {
if p.Options[selectedOption] == optionText {
p.selectedOptions = append(p.selectedOptions[:i], p.selectedOptions[i+1:]...)
break
}
}
} else {
// Add to selected options
p.selectedOptions = append(p.selectedOptions, p.findOptionByText(optionText))
}
}
func (p *InteractiveMultiselectPrinter) renderSelectMenu() string {
var content string
content += Sprintf("%s: %s\n", p.text, p.fuzzySearchString)
// find options that match fuzzy search string
rankedResults := fuzzy.RankFindFold(p.fuzzySearchString, p.Options)
// map rankedResults to fuzzySearchMatches
p.fuzzySearchMatches = []string{}
if len(rankedResults) != len(p.Options) {
sort.Sort(rankedResults)
}
for _, result := range rankedResults {
p.fuzzySearchMatches = append(p.fuzzySearchMatches, result.Target)
}
indexMapper := make([]string, len(p.fuzzySearchMatches))
for i := 0; i < len(p.fuzzySearchMatches); i++ {
// if in displayed options range
if i >= p.displayedOptionsStart && i < p.displayedOptionsEnd {
indexMapper[i] = p.fuzzySearchMatches[i]
}
}
for i, option := range indexMapper {
if option == "" {
continue
}
var checkmark string
if p.isSelected(option) {
checkmark = fmt.Sprintf("[%s]", p.Checkmark.Checked)
} else {
checkmark = fmt.Sprintf("[%s]", p.Checkmark.Unchecked)
}
if i == p.selectedOption {
content += Sprintf("%s %s %s\n", p.renderSelector(), checkmark, option)
} else {
content += Sprintf(" %s %s\n", checkmark, option)
}
}
help := fmt.Sprintf("%s: %s | %s: %s | left: %s | right: %s", p.KeySelect, Bold.Sprint("select"), p.KeyConfirm, Bold.Sprint("confirm"), Bold.Sprint("none"), Bold.Sprint("all"))
if p.Filter {
help += fmt.Sprintf("| type to %s", Bold.Sprint("filter"))
}
content += ThemeDefault.SecondaryStyle.Sprintfln(help)
return content
}
func (p InteractiveMultiselectPrinter) renderFinishedMenu() string {
var content string
content += Sprintf("%s: %s\n", p.text, p.fuzzySearchString)
for _, option := range p.selectedOptions {
content += Sprintf(" %s %s\n", p.renderSelector(), p.Options[option])
}
return content
}
func (p InteractiveMultiselectPrinter) renderSelector() string {
return p.SelectorStyle.Sprint(p.Selector)
}
|