Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.

Commit

Permalink
Keeping filter active after selecting - useful for MultiSelect (#278)
Browse files Browse the repository at this point in the history 
* Add FilterKeep setting (#277)

* Renamed FilterKeep to KeepFilter (#277)
  • Loading branch information
@siredmar
siredmar authored Feb 25, 2020
1 parent adb6805 commit dd61e43
Show file tree
Hide file tree
Showing 6 changed files with 369 additions and 10 deletions.
18 changes: 18 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,24 @@ func myFilter(filterValue string, optValue string, optIndex int) bool {
survey.AskOne(prompt, &color, survey.WithFilter(myFilter))
```

## Keeping the filter active

By default the filter will disappear if the user selects one of the filtered elements. Once the user selects one element the filter setting is gone.

However the user can prevent this from happening and keep the filter active for multiple selections in a e.g. MultiSelect:

```golang
// configure it for a specific prompt
&Select{
Message: "Choose a color:",
Options: []string{"light-green", "green", "dark-green", "red"},
KeepFilter: true,
}

// or define a default for all of the questions
survey.AskOne(prompt, &color, survey.WithKeepFilter(true))
```

## Validation

Validating individual responses for a particular question can be done by defining a
Expand Down
277 changes: 277 additions & 0 deletions examples/longmultikeepfilter.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,277 @@
package main

import (
"fmt"
"strings"

survey "github.com/AlecAivazis/survey/v2"
)

// the questions to ask
var multiQs = []*survey.Question{
{
Name: "letter",
Prompt: &survey.MultiSelect{
Message: "Choose one or more words :",
Options: []string{
"Afghanistan",
"Åland Islands",
"Albania",
"Algeria",
"American Samoa",
"AndorrA",
"Angola",
"Anguilla",
"Antarctica",
"Antigua and Barbuda",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia",
"Bosnia and Herzegovina",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territory",
"Brunei Darussalam",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cambodia",
"Cameroon",
"Canada",
"Cape Verde",
"Cayman Islands",
"Central African Republic",
"Chad",
"Chile",
"China",
"Christmas Island",
"Cocos (Keeling) Islands",
"Colombia",
"Comoros",
"Congo",
"Congo, The Democratic Republic of the",
"Cook Islands",
"Costa Rica",
"Cote D'Ivoire",
"Croatia",
"Cuba",
"Cyprus",
"Czech Republic",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Ethiopia",
"Falkland Islands (Malvinas)",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"French Guiana",
"French Polynesia",
"French Southern Territories",
"Gabon",
"Gambia",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guam",
"Guatemala",
"Guernsey",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Heard Island and Mcdonald Islands",
"Holy See (Vatican City State)",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran, Islamic Republic Of",
"Iraq",
"Ireland",
"Isle of Man",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jersey",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"Korea, Democratic People'S Republic of",
"Korea, Republic of",
"Kuwait",
"Kyrgyzstan",
"Lao People'S Democratic Republic",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libyan Arab Jamahiriya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macao",
"Macedonia, The Former Yugoslav Republic of",
"Madagascar",
"Malawi",
"Malaysia",
"Maldives",
"Mali",
"Malta",
"Marshall Islands",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia, Federated States of",
"Moldova, Republic of",
"Monaco",
"Mongolia",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands",
"Netherlands Antilles",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk Island",
"Northern Mariana Islands",
"Norway",
"Oman",
"Pakistan",
"Palau",
"Palestinian Territory, Occupied",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn",
"Poland",
"Portugal",
"Puerto Rico",
"Qatar",
"Reunion",
"Romania",
"Russian Federation",
"RWANDA",
"Saint Helena",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"Samoa",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia and Montenegro",
"Seychelles",
"Sierra Leone",
"Singapore",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"Spain",
"Sri Lanka",
"Sudan",
"Suriname",
"Svalbard and Jan Mayen",
"Swaziland",
"Sweden",
"Switzerland",
"Syrian Arab Republic",
"Taiwan, Province of China",
"Tajikistan",
"Tanzania, United Republic of",
"Thailand",
"Timor-Leste",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates",
"United Kingdom",
"United States",
"United States Minor Outlying Islands",
"Uruguay",
"Uzbekistan",
"Vanuatu",
"Venezuela",
"Viet Nam",
"Virgin Islands, British",
"Virgin Islands, U.S.",
"Wallis and Futuna",
"Western Sahara",
"Yemen",
"Zambia",
"Zimbabwe",
},
},
},
}

func main() {
answers := []string{}

// ask the question
err := survey.Ask(multiQs, &answers, survey.WithKeepFilter(true))

if err != nil {
fmt.Println(err.Error())
return
}
// print the answers
fmt.Printf("you chose: %s\n", strings.Join(answers, ", "))
}
4 changes: 3 additions & 1 deletion multiselect.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ func (m *MultiSelect) OnChange(key rune, config *PromptConfig) {
// otherwise just invert the current value
m.checked[selectedOpt.Index] = !old
}
m.filter = ""
if !config.KeepFilter {
m.filter = ""
}
}
// only show the help message if we have one to show
} else if string(key) == config.HelpInput && m.Help != "" {
Expand Down
36 changes: 35 additions & 1 deletion multiselect_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"strings"
"testing"

"github.com/Netflix/go-expect"
expect "github.com/Netflix/go-expect"
"github.com/stretchr/testify/assert"

"github.com/AlecAivazis/survey/v2/core"
Expand Down Expand Up @@ -363,3 +363,37 @@ func TestMultiSelectPrompt(t *testing.T) {
})
}
}

func TestMultiSelectPromptKeepFilter(t *testing.T) {
tests := []PromptTest{
{
"multi select with filter keep",
&MultiSelect{
Message: "What color do you prefer:",
Options: []string{"green", "red", "light-green", "blue", "black", "yellow", "purple"},
},
func(c *expect.Console) {
c.ExpectString("What color do you prefer: [Use arrows to move, enter to select, type to filter]")
// Filter down to green
c.Send("green")
// Select green.
c.Send(" ")
// Select light-green.
c.Send(string(terminal.KeyArrowDown))
c.Send(" ")
c.SendLine("")
c.ExpectEOF()
},
[]core.OptionAnswer{
core.OptionAnswer{Value: "green", Index: 0},
core.OptionAnswer{Value: "light-green", Index: 2},
},
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
RunPromptTestKeepFilter(t, test)
})
}
}
Loading

0 comments on commit dd61e43

Please sign in to comment.