Getting started with Vue DropDownList component

This section briefly explains how to create a simple DropDownList component and configure its available functionalities in Vue.

To get start quickly with DropDownList Component using Vue CLI, you can check on this video:

Prerequisites

System requirements for Syncfusion Vue UI components

Get Started with Vue CLI

You can use Vue CLI to setup your vue applications. To install Vue CLI use the following command.

npm install -g @vue/cli

Start a new project using below Vue CLI command.

vue init webpack-simple quickstart

cd quickstart
npm install

Adding Syncfusion packages

All the available Essential JS 2 packages are published in npmjs.com registry. You can choose the component that you want to install. For this application, we are going to use DropDownList component.

To install DropDownList component, use the following command

npm install @syncfusion/ej2-vue-dropdowns --save

Registering Vue Component

For Registering Vue Component two ways are available. They are as follows.

• Vue.use()
• Vue.component()

Using Vue.use()

Import the Component Plugin from the EJ2 Vue Package and register the same using Vue.use() with Component Plugin as its argument.

Refer the code snippet given below.

import { DropDownListPlugin } from '@syncfusion/ej2-vue-dropdowns';

Vue.use(DropDownListPlugin);

By Registering Component Plugin in Vue, all child directives are also globally registered.

Using Vue.component()

Import the Component and Component Plugin from EJ2 Vue Package, register the same using the Vue.component() with name of Component from ComponentPlugin and the EJ2 Vue Component as its arguments.

Refer the code snippet given below.

import { DropDownListComponent, DropDownListPlugin } from '@syncfusion/ej2-vue-dropdowns';

Vue.component(DropDownListPlugin.name, DropDownListComponent);

By using Vue.component(), only the EJ2 Vue Component is registered. Child directives needs to be registered separately.

Creating Vue Sample

Add the EJ2 Vue DropDownList using <ejs-dropdownlist> to the <template> section of the App.vue file in src directory, the content attribute of the DropDownList component is provided as name in data option in the <script> section.

<template>
<div class="control_wrapper">
    <ejs-dropdownlist id='dropdownlist'></ejs-dropdownlist>
</div>
</template>
<script>
import Vue from 'vue';
import { DropDownListPlugin } from "@syncfusion/ej2-vue-dropdowns";
Vue.use(DropDownListPlugin);

export default Vue.extend({
  data: function() {
return {

};
  }
});

</script>

Adding CSS Reference

Add ComboBox component’s styles as given below in <style> section of the App.vue file.

<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-inputs/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-dropdowns/styles/material.css";
</style>

Binding data source

After initialization, populate the DropDownList with data using the dataSource  property. Here, an array of string values is passed to the DropDownList component.

<template>
<div class="control_wrapper">
    <ejs-dropdownlist id='dropdownlist' :dataSource='sportsData'></ejs-dropdownlist>
</div>
</template>
<script>
import Vue from 'vue';
import { DropDownListPlugin } from "@syncfusion/ej2-vue-dropdowns";
Vue.use(DropDownListPlugin);

export default Vue.extend({
  data: function() {
return {
  sportsData: ['Badminton', 'Cricket', 'Football', 'Golf', 'Tennis']
};
  }
});

</script>

Run the application

After completing the configuration required to render a basic DropDownList, run the following command to display the output in your default browser.

npm run dev

<template>
  <div id="app">
<div id='container' style="margin:50px auto 0; width:250px;">
    <br>
    <ejs-dropdownlist id='dropdownlist' :dataSource='sportsData' placeholder='Select a game'></ejs-dropdownlist>
</div>
  </div>
</template>
<script>
import Vue from 'vue';
import { DropDownListPlugin } from "@syncfusion/ej2-vue-dropdowns";

Vue.use(DropDownListPlugin);
export default {
  data (){
return {
  sportsData: ['Badminton', 'Cricket', 'Football', 'Golf', 'Tennis'];
}
  }
}

</script>
<style>
@import "../../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-inputs/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-vue-dropdowns/styles/material.css";
</style>

Configure the Popup List

By default, the width of the popup list automatically adjusts according to the DropDownList input element’s width, and the height of the popup list has ‘300px’.

The height and width of the popup list can also be customized using the popupHeight  and popupWidth properties respectively

<template>
  <div id="app">
<div id='container' style="margin:50px auto 0; width:250px;">
    <br>
    <ejs-dropdownlist id='dropdownlist' popupHeight="200px" popupWidth="250px" :dataSource='sportsData' placeholder='Select a game'></ejs-dropdownlist>
</div>
  </div>
</template>
<script>
import Vue from 'vue';
import { DropDownListPlugin } from "@syncfusion/ej2-vue-dropdowns";

Vue.use(DropDownListPlugin);
export default {
  data (){
return {
  sportsData: ['Badminton', 'Cricket', 'Football', 'Golf', 'Tennis'];
}
  }
}

</script>
<style>
@import "../../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-inputs/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-vue-dropdowns/styles/material.css";
</style>

You can refer to our Vue Dropdown List feature tour page for its groundbreaking feature representations. You can also explore our Vue Dropdown list example that shows how to render the Dropdown List in Vue.

See Also

• How to bind the data