Name | Type | Default | Description |
---|---|---|---|
value v-model | String, Number | NULL | This is the prop that the v-model will bind to. So if you are using v-model you can omit this. |
items | Array | NULL | This is the list of options. [{Option data...},{Option data...}] |
placeholder | String | Select... | The placeholder in the select when nothing is selected. |
minSearch | Number | 0 | Minimum number of characters typed in the search box needed to trigger the search |
multiple | Boolean | false | Whether or not to support multiple selections |
taggable | Boolean | false | When true the user is allowed to enter values not in the list items. |
groupBy | String | NULL | The key to group items by. Dot notation is supported for nested values in the items. |
showTagInList | Boolean | false | Depends on taggable. When true the taggable will be shown in the list as "Add {term}" |
delay | Number | 100 | The amount of delay to be used when searching |
searchThreshold | Number | 7 | The minimum number of items for the search input to be shown. |
keepTextOnDelete | Boolean | false | When set to true if a user deletes a selection it will retain the text of the selection |
itemFilter | Function, String | selectionKey | When a function is provided it will be used when filtering results from the search box. The function should accept the item as a parameter and should return true for a match. If a String is provided it is used as the key to filter on when filtering items. |
selectionKey | String | name | This is the key used as the value for the items. And it is used to display selections |
listHeight | String | 250px | The height of the drop down list |
cacheResults | Boolean | true | Whether or not to cache search results. |
paginated | Boolean | false | Whether or not the search data is being paginated. When true the select will emit the search event when the list is navigated to the end. |
paginateThreshold | Number | 3 | Determines when the paginate request will be called. So when the user scrolls down the list if this is set to 3 the request will be made when the user is 3 list items away from the bottom of the list. |
stopParentScroll | Boolean | true | When set to true the list will automatically prevent the parent container from scrolling when the list scroll has reached the bottom. |
emptyMessage | String | A message to use when the select is empty. (ex: "No Results"). If left blank then no message will show up. | |
acceptEmptySelection | Boolean | false | Works with the emptyMessage property. If this is set to true the empty option will be a selectable item instead of just text. |