vue-simple-complete

A simple autocomplete input 🔨 built using Vue.JS & Typescript.

Project setup

yarn add vue-simple-complete

npm i vue-simple-complete


<script>
  import VueSimpleComplete from "vue-simple-complete";

  export default {
    name: 'app',
    data() {
    },
    components: {
      VueSimpleComplete
    },
  };
</script>

Wiki

Props Type Description
:items Array This contains data for the auto-complete, this can either be an array of string or an array of custom objects
:objectMatchkey String This is required if the items is of type object array. The objectMatchKey then becomes the key that is used within the match function
:template Object This is required if the items is of type object array. The template is then used to display the items as per the defined template. If the template is not defined then ObjectMatchKey will be used to form the items display
Function Type Description
@inputChanged Function When input is changed this event gets fired. The consumers of the vue-simple-complete component can listen to this event and get the entered or selected value

📄 Additional Info:

  • The component comes with a basic styling, and the items panel usually takes the full width of the container it's placed in. To contain it's width, it can be wrapped within a div with custom width.
  • Up & Down keys can be used to go over the items in the list.
  • Down key can be used to open the items panel, when the panel is collapsed.
  • Esc key will clear out the selected value when the focus is on the input

Example-1: With items of Object type

<vue-simple-complete
        :items="items"
        :objectMatchkey="objectMatchkey"
        :template="template"
        @inputChanged="onInputChanged">
</vue-simple-complete>


<script>
  import VueSimpleComplete from "vue-simple-complete";

  export default {
    name: 'app',
    components: {
      "vue-simple-complete": VueSimpleComplete
    },
    data() {
        return {
            items: [
                { Id: 1, Name: "Amsterdam" },
                { Id: 2, Name: "Berlin" },
                { Id: 3, Name: "London" },
                { Id: 4, Name: "Mumbai" }
            ],
            objectMatchkey: "Name",
            template: {
                keys: ["Id", "Name"],
                separator: ", "
            },
            changedInput: ""
        };
    },
    methods: {
        onInputChanged(value) {
            this.changedInput = value;
        }
    }
  };
</script>

object-ex-1

object-ex-2

object-ex-3

Example-2: With items of string type

<vue-simple-complete
        :items="items"
        @inputChanged="onInputChanged">
</vue-simple-complete>


<script>
  import VueSimpleComplete from "vue-simple-complete";

  export default {
    name: 'app',
    components: {
      "vue-simple-complete": VueSimpleComplete
    },
    data() {
        return {
            items: [
                "Amsterdam",
                "Berlin",
                "London",
                "Mumbai"
            ],
            changedInput: ""
        };
    },
    methods: {
        onInputChanged(value) {
            this.changedInput = value;
        }
    }
  };
</script>

string-ex-1

string-ex-2

string-ex-3

Note:

There is a known issue where you will see the following error when you import the component into a TypeScript project

Could not find a declaration file for module 'vue-simple-complete'.
Try `npm install @types/vue-simple-complete` if it exists or add a new declaration (.d.ts) file containing `declare module 'vue-simple-complete';`

As a temporary solution, please edit your TypeScript Config file (tsconfig.json) and add a new key value pair, as -


"noImplicitAny": false

GitHub