vue-single-select

vue-single-select

simple autocomplete select dropdown component for Vue apps for you!

Demo

Check it out on Code Pen

What It Does

vue-single-select provides a simple interface to replace regular select elements with an auto-complete select element like Chosen for jQuery.

What It Does Not Do

Nope no Multi Select. See vue-multiple-select for this.

No ajax loading.

No massive styling options (for now).

Usage

Install it

$ npm i vue-single-select

Register it

In your component:

import VueSingleSelect from "vue-single-select";
export default {
components: {
     VueSingleSelect
  },
  //...
}

Globally:

import VueSingleSelect from "vue-single-select";
Vue.component('vue-single-select', VueSingleSelect);

Use It

<vue-single-select
        v-model="fruit"
        :options="['apple','banana','cherry','tomato']"
        :required="true"
></vue-single-select>

Use It Again

<vue-single-select
        name="maybe"
        placeholder="pick a post"
        you-want-to-select-a-post="ok"
        v-model="post"
        out-of-all-these-posts="makes sense"
        :options="posts"
        a-post-has-an-id="good for search and display"
        option-key="id"
        the-post-has-a-title="make sure to show these"
        option-label="title"
></vue-single-select>

Use It Again

<vue-single-select
        you-want-to-select-a-reply="yes"
        v-model="reply"
        out-of-all-these-replies="yep"
        :options="replies"
        a-reply-only-has-a-reply="sounds about right"
        option-label="reply"
        seed-an-initial-value="what's seed mean?"
        initial="seed me"
        you-only-want-20-options-to-show="is 20 enough?"
        :max-results="20"
></vue-single-select>

Dont like the Styling

You can override some of it. Like so:

<vue-single-select
        id="selected-reply"
        name="a_reply"
        option-label="reply"
        v-model="reply"
        :options="replies"
        you-like-huge-dropdowns="1000px is long!"
        max-height="1000px"
        you-love-bootstrap="yes!!"
        :classes="{
                    input: 'form-control',
                    wrapper: 'form-group',
                    icon: 'glyphicon',
                    required: 'required'
        }"
></vue-single-select>

Then all you need to do is provide some class definitions like so:

.form-control {
    color: pink;
    width: 10000px;
    _go: nuts;
}
.glyphicon {
    display:none;
}
.form-group {
    background-color: pink;
}

/* note that there is subtle default styling for required input. */
.required {
    color: #721c24;
    background-color: #f8d7da;
    border-color: #f5c6cb;
}

Kitchen Sink

Meh, see props below.

Why vue-single-select is better

1. It handles custom label/value props for displaying options.

   Other select components require you to conform to their format. Which often means data wrangling.

2. It's easier on the DOM.

   Other components will load up all the options available in the select element. This can be heavy. vue-single-select makes an executive decision that you probably will not want to scroll more than N options before you want to narrow things down a bit. You can change this, but the default is 30.

3. Snappy Event Handling

   • up and down arrows for selecting options
   • enter to select first match
   • remembers selection on change
   • hit the escape key to, well, escape

4. Lightweight

   • Why are the other packages so big and actually have dependencies?

5. It works for regular 'POST backs' to the server.

   If you are doing a regular post or just gathering the form data you don't need to do anything extra to provide a name and value for the selected option.

6. Mine just looks nicer

7. It's simple!!

Available Props:

There are more props than I'd like. But I needed them so you might too.

    props: {
    value: {
      required: true
    },
    // Give your element a name.
    // Good for doing a POST
    name: {
      type: String,
      required: false,
      default: () => ""
    },
    // Your list of things for the select
    options: {
      type: Array,
      required: false,
      default: () => []
    },
    // Tells vue-single-select what key to use
    // for generating option labels
    optionLabel: {
      type: String,
      required: false,
      default: () => null
    },
    // Tells vue-single-select the value
    // you want populated in the select for the 
    // input
    optionKey: {
      type: String,
      required: false,
      default: () => null
    },
    placeholder: {
      type: String,
      required: false,
      default: () => "Search Here"
    },
    maxHeight: {
      type: String,
      default: () => "220px",
      required: false
    },
    //Give your input an html element id
    inputId: {
      type: String,
      default: () => "single-select",
      required: false
    },
    classes: {
      type: Object,
      required: false,
      default: () => {
        return {
          wrapper: "single-select-wrapper",
          input: "form-control",
          icon: "icon",
          required: "required"
        };
      }
    },
    // Seed search text with initial value
    initial: {
      type: String,
      required: false,
      default: () => null
    },
    required: {
      type: Boolean,
      required: false,
      default: () => false
    },
    maxResults: {
      type: Number,
      required: false,
      default: () => 30
    },
    tabindex: {
      type: String,
      required: false,
      default: () => {
        return "";
      }
    },
    // Tell vue-single-select what to display
    // as the selected option
    getOptionDescription: {
      type: Function,
      default(option) {
        if (this.optionKey && this.optionLabel) {
          return option[this.optionKey] + " " + option[this.optionLabel];
        }
        if (this.optionLabel) {
          return option[this.optionLabel];
        }
        if (this.optionKey) {
          return option[this.optionKey];
        }
            return option;
      }
    },
    // Use this to actually give vue-single-select
    // a value for doing a POST
    getOptionValue: {
      type: Function,
      default(option) {
        if (this.optionKey) {
          return option[this.optionKey];
        }
        
        if (this.optionLabel) {
          return option[this.optionLabel];
        }

        return option;
      }
    }
  }

Q&A

Q. What about Ajax?

A. Good question. Why aren't you passing that in as a prop? Seriously, this is just a widget why does it need knowledge of it's data source?

Q. What about Templating?

A. Good question. Really. Working on it.

Q. What about Multiple Selects?

A. Nope not found here.

Q. Why doesn't it work?

A. You know I really didn't make this to be used without a bundler and the vue-loader. If you don't know what this means then checkout Parcel or Vue Cli to get started. You're going to want it anyway.

Or if you are ready to roll but need a helping hand use Laravel Mix It's your one stop to success!