Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/romainsimon/vue-simple-search-dropdown

:eight_pointed_black_star: Vue.js simple autocomplete dropdown component
https://github.com/romainsimon/vue-simple-search-dropdown

component dropdown vue vuejs

Last synced: 1 day ago
JSON representation

:eight_pointed_black_star: Vue.js simple autocomplete dropdown component

Awesome Lists containing this project

README

        

# vue-simple-search-dropdown

A Vue component for a simple searchable dropdown.

No external library is used in this dropdown.

### Demo

Demo here: [https://romainsimon.github.io/vue-simple-search-dropdown/](https://romainsimon.github.io/vue-simple-search-dropdown/)

## Installation

```js
npm install vue-simple-search-dropdown
```

### Browser

Include the script file, then install the component with `Vue.use(Dropdown);` e.g.:

```html

Vue.use(Dropdown);

```

### Module

```js
import Dropdown from 'vue-simple-search-dropdown';
```

## Usage

Once installed, it can be used in a template as simply as:

```html

```

### Options

- `options` (required): An array of options with `id` and `name`
- `placeholder` (optional): A placeholder
- `disabled` (optional): true/false
- `name` (optional): An input name | default: `dropdown`
- `maxItem` (optional): Max item to show | default: `6`

### Events

These events are returned from the dropdown and can be catch with `v-on`
- `selected`: An option is selected by click in the dropdown
- `filter`: A filter has been applied by typing in the input field

Tips: Using `v-on:filter`, you can repopulate the dropdown with new `options` corresponding to the search by making an API call