2
0
mirror of https://github.com/tenrok/vue-select.git synced 2026-05-17 02:29:37 +03:00
Files
vue-select/docs/content/guide/selectable.md
T
Jeff Sagal 6d59e6fd02 init
2022-07-26 22:04:12 -07:00

1.2 KiB

Selectable Prop

The selectable prop determines if an option is selectable or not. If selectable returns false for a given option, it will be displayed with a vs__dropdown-option--disabled class. The option will be disabled and unable to be selected.

selectable: {
  type: Function,
  /**
   * @param {Object|String} option
   * @return {boolean}
   */
  default: option => true,
},

Example

Here selectable is used to prevent books by a certain author from being chosen. In this case, the options passed to the component are objects:

{ 
    title: "Right Ho Jeeves", 
    author: { firstName: "P.D", lastName: "Woodhouse" }, 
}

This object will be passed to selectable, so we can check if the author should be selectable or not.

<<< @/.vitepress/components/UnselectableExample.vue{6}

Limiting the Number of Selections

selectable can also be used a bit more creatively to limit the number selections that can be made within the component. In this case, the user can select any author, but may only select a maximum of three books.

<<< @/.vitepress/components/LimitSelectionQuantity.vue{8}