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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
|
package huh
import (
"fmt"
"strings"
"time"
"github.com/charmbracelet/bubbles/key"
"github.com/charmbracelet/bubbles/spinner"
"github.com/charmbracelet/bubbles/textinput"
"github.com/charmbracelet/bubbles/viewport"
tea "github.com/charmbracelet/bubbletea"
"github.com/charmbracelet/huh/accessibility"
"github.com/charmbracelet/lipgloss"
)
const minHeight = 1
const defaultHeight = 10
// Select is a select field.
//
// A select field is a field that allows the user to select from a list of
// options. The options can be provided statically or dynamically using Options
// or OptionsFunc. The options can be filtered using "/" and navigation is done
// using j/k, up/down, or ctrl+n/ctrl+p keys.
type Select[T comparable] struct {
id int
accessor Accessor[T]
key string
viewport viewport.Model
title Eval[string]
description Eval[string]
options Eval[[]Option[T]]
filteredOptions []Option[T]
validate func(T) error
err error
selected int
focused bool
filtering bool
filter textinput.Model
spinner spinner.Model
inline bool
width int
height int
accessible bool
theme *Theme
keymap SelectKeyMap
}
// NewSelect creates a new select field.
//
// A select field is a field that allows the user to select from a list of
// options. The options can be provided statically or dynamically using Options
// or OptionsFunc. The options can be filtered using "/" and navigation is done
// using j/k, up/down, or ctrl+n/ctrl+p keys.
func NewSelect[T comparable]() *Select[T] {
filter := textinput.New()
filter.Prompt = "/"
s := spinner.New(spinner.WithSpinner(spinner.Line))
return &Select[T]{
accessor: &EmbeddedAccessor[T]{},
validate: func(T) error { return nil },
filtering: false,
filter: filter,
options: Eval[[]Option[T]]{cache: make(map[uint64][]Option[T])},
title: Eval[string]{cache: make(map[uint64]string)},
description: Eval[string]{cache: make(map[uint64]string)},
spinner: s,
}
}
// Value sets the value of the select field.
func (s *Select[T]) Value(value *T) *Select[T] {
return s.Accessor(NewPointerAccessor(value))
}
// Accessor sets the accessor of the select field.
func (s *Select[T]) Accessor(accessor Accessor[T]) *Select[T] {
s.accessor = accessor
s.selectValue(s.accessor.Get())
s.updateValue()
return s
}
func (s *Select[T]) selectValue(value T) {
for i, o := range s.options.val {
if o.Value == value {
s.selected = i
break
}
}
}
// Key sets the key of the select field which can be used to retrieve the value
// after submission.
func (s *Select[T]) Key(key string) *Select[T] {
s.key = key
return s
}
// Title sets the title of the select field.
//
// This title will be static, for dynamic titles use `TitleFunc`.
func (s *Select[T]) Title(title string) *Select[T] {
s.title.val = title
s.title.fn = nil
return s
}
// TitleFunc sets the title func of the select field.
//
// This TitleFunc will be re-evaluated when the binding of the TitleFunc
// changes. This when you want to display dynamic content and update the title
// when another part of your form changes.
//
// See README#Dynamic for more usage information.
func (s *Select[T]) TitleFunc(f func() string, bindings any) *Select[T] {
s.title.fn = f
s.title.bindings = bindings
return s
}
// Filtering sets the filtering state of the select field.
func (s *Select[T]) Filtering(filtering bool) *Select[T] {
s.filtering = filtering
s.filter.Focus()
return s
}
// Description sets the description of the select field.
//
// This description will be static, for dynamic descriptions use `DescriptionFunc`.
func (s *Select[T]) Description(description string) *Select[T] {
s.description.val = description
return s
}
// DescriptionFunc sets the description func of the select field.
//
// This DescriptionFunc will be re-evaluated when the binding of the
// DescriptionFunc changes. This is useful when you want to display dynamic
// content and update the description when another part of your form changes.
//
// See README#Dynamic for more usage information.
func (s *Select[T]) DescriptionFunc(f func() string, bindings any) *Select[T] {
s.description.fn = f
s.description.bindings = bindings
return s
}
// Options sets the options of the select field.
//
// This is what your user will select from.
//
// Title
// Description
//
// -> Option 1
// Option 2
// Option 3
//
// These options will be static, for dynamic options use `OptionsFunc`.
func (s *Select[T]) Options(options ...Option[T]) *Select[T] {
if len(options) <= 0 {
return s
}
s.options.val = options
s.filteredOptions = options
// Set the cursor to the existing value or the last selected option.
for i, option := range options {
if option.Value == s.accessor.Get() {
s.selected = i
break
} else if option.selected {
s.selected = i
}
}
s.updateViewportHeight()
s.updateValue()
return s
}
// OptionsFunc sets the options func of the select field.
//
// This OptionsFunc will be re-evaluated when the binding of the OptionsFunc
// changes. This is useful when you want to display dynamic content and update
// the options when another part of your form changes.
//
// For example, changing the state / provinces, based on the selected country.
//
// huh.NewSelect[string]().
// Options(huh.NewOptions("United States", "Canada", "Mexico")...).
// Value(&country).
// Title("Country").
// Height(5),
//
// huh.NewSelect[string]().
// Title("State / Province"). // This can also be made dynamic with `TitleFunc`.
// OptionsFunc(func() []huh.Option[string] {
// s := states[country]
// time.Sleep(1000 * time.Millisecond)
// return huh.NewOptions(s...)
// }, &country),
//
// See examples/dynamic/dynamic-country/main.go for the full example.
func (s *Select[T]) OptionsFunc(f func() []Option[T], bindings any) *Select[T] {
s.options.fn = f
s.options.bindings = bindings
// If there is no height set, we should attach a static height since these
// options are possibly dynamic.
if s.height <= 0 {
s.height = defaultHeight
s.updateViewportHeight()
}
return s
}
// Inline sets whether the select input should be inline.
func (s *Select[T]) Inline(v bool) *Select[T] {
s.inline = v
if v {
s.Height(1)
}
s.keymap.Left.SetEnabled(v)
s.keymap.Right.SetEnabled(v)
s.keymap.Up.SetEnabled(!v)
s.keymap.Down.SetEnabled(!v)
return s
}
// Height sets the height of the select field. If the number of options exceeds
// the height, the select field will become scrollable.
func (s *Select[T]) Height(height int) *Select[T] {
s.height = height
s.updateViewportHeight()
return s
}
// Validate sets the validation function of the select field.
func (s *Select[T]) Validate(validate func(T) error) *Select[T] {
s.validate = validate
return s
}
// Error returns the error of the select field.
func (s *Select[T]) Error() error { return s.err }
// Skip returns whether the select should be skipped or should be blocking.
func (*Select[T]) Skip() bool { return false }
// Zoom returns whether the input should be zoomed.
func (*Select[T]) Zoom() bool { return false }
// Focus focuses the select field.
func (s *Select[T]) Focus() tea.Cmd {
s.focused = true
return nil
}
// Blur blurs the select field.
func (s *Select[T]) Blur() tea.Cmd {
value := s.accessor.Get()
if s.inline {
s.clearFilter()
s.selectValue(value)
}
s.focused = false
s.err = s.validate(value)
return nil
}
// KeyBinds returns the help keybindings for the select field.
func (s *Select[T]) KeyBinds() []key.Binding {
return []key.Binding{
s.keymap.Up,
s.keymap.Down,
s.keymap.Left,
s.keymap.Right,
s.keymap.Filter,
s.keymap.SetFilter,
s.keymap.ClearFilter,
s.keymap.Prev,
s.keymap.Next,
s.keymap.Submit,
}
}
// Init initializes the select field.
func (s *Select[T]) Init() tea.Cmd {
return nil
}
// Update updates the select field.
func (s *Select[T]) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
s.updateViewportHeight()
var cmd tea.Cmd
if s.filtering {
s.filter, cmd = s.filter.Update(msg)
// Keep the selected item in view.
if s.selected < s.viewport.YOffset || s.selected >= s.viewport.YOffset+s.viewport.Height {
s.viewport.SetYOffset(s.selected)
}
}
switch msg := msg.(type) {
case updateFieldMsg:
var cmds []tea.Cmd
if ok, hash := s.title.shouldUpdate(); ok {
s.title.bindingsHash = hash
if !s.title.loadFromCache() {
s.title.loading = true
cmds = append(cmds, func() tea.Msg {
return updateTitleMsg{id: s.id, title: s.title.fn(), hash: hash}
})
}
}
if ok, hash := s.description.shouldUpdate(); ok {
s.description.bindingsHash = hash
if !s.description.loadFromCache() {
s.description.loading = true
cmds = append(cmds, func() tea.Msg {
return updateDescriptionMsg{id: s.id, description: s.description.fn(), hash: hash}
})
}
}
if ok, hash := s.options.shouldUpdate(); ok {
s.clearFilter()
s.options.bindingsHash = hash
if s.options.loadFromCache() {
s.filteredOptions = s.options.val
s.selected = clamp(s.selected, 0, len(s.options.val)-1)
} else {
s.options.loading = true
s.options.loadingStart = time.Now()
cmds = append(cmds, func() tea.Msg {
return updateOptionsMsg[T]{id: s.id, hash: hash, options: s.options.fn()}
}, s.spinner.Tick)
}
}
return s, tea.Batch(cmds...)
case spinner.TickMsg:
if !s.options.loading {
break
}
s.spinner, cmd = s.spinner.Update(msg)
return s, cmd
case updateTitleMsg:
if msg.id == s.id && msg.hash == s.title.bindingsHash {
s.title.update(msg.title)
}
case updateDescriptionMsg:
if msg.id == s.id && msg.hash == s.description.bindingsHash {
s.description.update(msg.description)
}
case updateOptionsMsg[T]:
if msg.id == s.id && msg.hash == s.options.bindingsHash {
s.options.update(msg.options)
// since we're updating the options, we need to update the selected cursor
// position and filteredOptions.
s.selected = clamp(s.selected, 0, len(msg.options)-1)
s.filteredOptions = msg.options
s.updateValue()
}
case tea.KeyMsg:
s.err = nil
switch {
case key.Matches(msg, s.keymap.Filter):
s.setFiltering(true)
return s, s.filter.Focus()
case key.Matches(msg, s.keymap.SetFilter):
if len(s.filteredOptions) <= 0 {
s.filter.SetValue("")
s.filteredOptions = s.options.val
}
s.setFiltering(false)
case key.Matches(msg, s.keymap.ClearFilter):
s.clearFilter()
case key.Matches(msg, s.keymap.Up, s.keymap.Left):
// When filtering we should ignore j/k keybindings
//
// XXX: Currently, the below check doesn't account for keymap
// changes. When making this fix it's worth considering ignoring
// whether to ignore all up/down keybindings as ignoring a-zA-Z0-9
// may not be enough when international keyboards are considered.
if s.filtering && (msg.String() == "k" || msg.String() == "h") {
break
}
s.selected = max(s.selected-1, 0)
if s.selected < s.viewport.YOffset {
s.viewport.SetYOffset(s.selected)
}
s.updateValue()
case key.Matches(msg, s.keymap.GotoTop):
if s.filtering {
break
}
s.selected = 0
s.viewport.GotoTop()
s.updateValue()
case key.Matches(msg, s.keymap.GotoBottom):
if s.filtering {
break
}
s.selected = len(s.filteredOptions) - 1
s.viewport.GotoBottom()
case key.Matches(msg, s.keymap.HalfPageUp):
s.selected = max(s.selected-s.viewport.Height/2, 0)
s.viewport.HalfViewUp()
s.updateValue()
case key.Matches(msg, s.keymap.HalfPageDown):
s.selected = min(s.selected+s.viewport.Height/2, len(s.filteredOptions)-1)
s.viewport.HalfViewDown()
s.updateValue()
case key.Matches(msg, s.keymap.Down, s.keymap.Right):
// When filtering we should ignore j/k keybindings
//
// XXX: See note in the previous case match.
if s.filtering && (msg.String() == "j" || msg.String() == "l") {
break
}
s.selected = min(s.selected+1, len(s.filteredOptions)-1)
if s.selected >= s.viewport.YOffset+s.viewport.Height {
s.viewport.LineDown(1)
}
s.updateValue()
case key.Matches(msg, s.keymap.Prev):
if s.selected >= len(s.filteredOptions) {
break
}
s.updateValue()
s.err = s.validate(s.accessor.Get())
if s.err != nil {
return s, nil
}
s.updateValue()
return s, PrevField
case key.Matches(msg, s.keymap.Next, s.keymap.Submit):
if s.selected >= len(s.filteredOptions) {
break
}
s.setFiltering(false)
s.updateValue()
s.err = s.validate(s.accessor.Get())
if s.err != nil {
return s, nil
}
s.updateValue()
return s, NextField
}
if s.filtering {
s.filteredOptions = s.options.val
if s.filter.Value() != "" {
s.filteredOptions = nil
for _, option := range s.options.val {
if s.filterFunc(option.Key) {
s.filteredOptions = append(s.filteredOptions, option)
}
}
}
if len(s.filteredOptions) > 0 {
s.selected = min(s.selected, len(s.filteredOptions)-1)
s.viewport.SetYOffset(clamp(s.selected, 0, len(s.filteredOptions)-s.viewport.Height))
}
}
}
return s, cmd
}
func (s *Select[T]) updateValue() {
if s.selected < len(s.filteredOptions) && s.selected >= 0 {
s.accessor.Set(s.filteredOptions[s.selected].Value)
}
}
// updateViewportHeight updates the viewport size according to the Height setting
// on this select field.
func (s *Select[T]) updateViewportHeight() {
// If no height is set size the viewport to the number of options.
if s.height <= 0 {
s.viewport.Height = len(s.options.val)
return
}
s.viewport.Height = max(minHeight, s.height-
lipgloss.Height(s.titleView())-
lipgloss.Height(s.descriptionView()))
}
func (s *Select[T]) activeStyles() *FieldStyles {
theme := s.theme
if theme == nil {
theme = ThemeCharm()
}
if s.focused {
return &theme.Focused
}
return &theme.Blurred
}
func (s *Select[T]) titleView() string {
var (
styles = s.activeStyles()
sb = strings.Builder{}
)
if s.filtering {
sb.WriteString(s.filter.View())
} else if s.filter.Value() != "" && !s.inline {
sb.WriteString(styles.Title.Render(s.title.val) + styles.Description.Render("/"+s.filter.Value()))
} else {
sb.WriteString(styles.Title.Render(s.title.val))
}
if s.err != nil {
sb.WriteString(styles.ErrorIndicator.String())
}
return sb.String()
}
func (s *Select[T]) descriptionView() string {
return s.activeStyles().Description.Render(s.description.val)
}
func (s *Select[T]) optionsView() string {
var (
styles = s.activeStyles()
c = styles.SelectSelector.String()
sb strings.Builder
)
if s.options.loading && time.Since(s.options.loadingStart) > spinnerShowThreshold {
s.spinner.Style = s.activeStyles().MultiSelectSelector.UnsetString()
sb.WriteString(s.spinner.View() + " Loading...")
return sb.String()
}
if s.inline {
sb.WriteString(styles.PrevIndicator.Faint(s.selected <= 0).String())
if len(s.filteredOptions) > 0 {
sb.WriteString(styles.SelectedOption.Render(s.filteredOptions[s.selected].Key))
} else {
sb.WriteString(styles.TextInput.Placeholder.Render("No matches"))
}
sb.WriteString(styles.NextIndicator.Faint(s.selected == len(s.filteredOptions)-1).String())
return sb.String()
}
for i, option := range s.filteredOptions {
if s.selected == i {
sb.WriteString(c + styles.SelectedOption.Render(option.Key))
} else {
sb.WriteString(strings.Repeat(" ", lipgloss.Width(c)) + styles.UnselectedOption.Render(option.Key))
}
if i < len(s.options.val)-1 {
sb.WriteString("\n")
}
}
for i := len(s.filteredOptions); i < len(s.options.val)-1; i++ {
sb.WriteString("\n")
}
return sb.String()
}
// View renders the select field.
func (s *Select[T]) View() string {
styles := s.activeStyles()
s.viewport.SetContent(s.optionsView())
var sb strings.Builder
if s.title.val != "" || s.title.fn != nil {
sb.WriteString(s.titleView())
if !s.inline {
sb.WriteString("\n")
}
}
if s.description.val != "" || s.description.fn != nil {
sb.WriteString(s.descriptionView())
if !s.inline {
sb.WriteString("\n")
}
}
sb.WriteString(s.viewport.View())
return styles.Base.Render(sb.String())
}
// clearFilter clears the value of the filter.
func (s *Select[T]) clearFilter() {
s.filter.SetValue("")
s.filteredOptions = s.options.val
s.setFiltering(false)
}
// setFiltering sets the filter of the select field.
func (s *Select[T]) setFiltering(filtering bool) {
if s.inline && filtering {
s.filter.Width = lipgloss.Width(s.titleView()) - 1 - 1
}
s.filtering = filtering
s.keymap.SetFilter.SetEnabled(filtering)
s.keymap.Filter.SetEnabled(!filtering)
s.keymap.ClearFilter.SetEnabled(!filtering && s.filter.Value() != "")
}
// filterFunc returns true if the option matches the filter.
func (s *Select[T]) filterFunc(option string) bool {
// XXX: remove diacritics or allow customization of filter function.
return strings.Contains(strings.ToLower(option), strings.ToLower(s.filter.Value()))
}
// Run runs the select field.
func (s *Select[T]) Run() error {
if s.accessible {
return s.runAccessible()
}
return Run(s)
}
// runAccessible runs an accessible select field.
func (s *Select[T]) runAccessible() error {
var sb strings.Builder
styles := s.activeStyles()
sb.WriteString(styles.Title.Render(s.title.val) + "\n")
for i, option := range s.options.val {
sb.WriteString(fmt.Sprintf("%d. %s", i+1, option.Key))
sb.WriteString("\n")
}
fmt.Println(sb.String())
for {
choice := accessibility.PromptInt("Choose: ", 1, len(s.options.val))
option := s.options.val[choice-1]
if err := s.validate(option.Value); err != nil {
fmt.Println(err.Error())
continue
}
fmt.Println(styles.SelectedOption.Render("Chose: " + option.Key + "\n"))
s.accessor.Set(option.Value)
break
}
return nil
}
// WithTheme sets the theme of the select field.
func (s *Select[T]) WithTheme(theme *Theme) Field {
if s.theme != nil {
return s
}
s.theme = theme
s.filter.Cursor.Style = theme.Focused.TextInput.Cursor
s.filter.Cursor.TextStyle = theme.Focused.TextInput.CursorText
s.filter.PromptStyle = theme.Focused.TextInput.Prompt
s.filter.TextStyle = theme.Focused.TextInput.Text
s.filter.PlaceholderStyle = theme.Focused.TextInput.Placeholder
s.updateViewportHeight()
return s
}
// WithKeyMap sets the keymap on a select field.
func (s *Select[T]) WithKeyMap(k *KeyMap) Field {
s.keymap = k.Select
s.keymap.Left.SetEnabled(s.inline)
s.keymap.Right.SetEnabled(s.inline)
s.keymap.Up.SetEnabled(!s.inline)
s.keymap.Down.SetEnabled(!s.inline)
return s
}
// WithAccessible sets the accessible mode of the select field.
func (s *Select[T]) WithAccessible(accessible bool) Field {
s.accessible = accessible
return s
}
// WithWidth sets the width of the select field.
func (s *Select[T]) WithWidth(width int) Field {
s.width = width
return s
}
// WithHeight sets the height of the select field.
func (s *Select[T]) WithHeight(height int) Field {
return s.Height(height)
}
// WithPosition sets the position of the select field.
func (s *Select[T]) WithPosition(p FieldPosition) Field {
if s.filtering {
return s
}
s.keymap.Prev.SetEnabled(!p.IsFirst())
s.keymap.Next.SetEnabled(!p.IsLast())
s.keymap.Submit.SetEnabled(p.IsLast())
return s
}
// GetKey returns the key of the field.
func (s *Select[T]) GetKey() string { return s.key }
// GetValue returns the value of the field.
func (s *Select[T]) GetValue() any {
return s.accessor.Get()
}
|