vue-simple-suggest
Advanced tools
Comparing version 1.0.1 to 1.1.0
{ | ||
"name": "vue-simple-suggest", | ||
"description": "Feature-rich autocomplete component for Vue.js", | ||
"version": "1.0.1", | ||
"version": "1.1.0", | ||
"author": "KazanExpress", | ||
@@ -6,0 +6,0 @@ "license": "MIT", |
@@ -17,4 +17,5 @@ # vue-simple-suggest | ||
- [What is it?](#what-is-it) | ||
- [Build](#build-setup) | ||
- [What is it?](#what-is-it) | ||
- [Controls](#default-controls) | ||
- [Component API](#component-api) | ||
@@ -31,5 +32,16 @@ - [TLDR](#tldr) | ||
- [Custom miscellanious item slots](#custom-miscellanious-item-slots) | ||
- [Roadmap](#roadmap) | ||
## Clone & Build Setup | ||
## What is it | ||
This is a simple yet feature-rich suggestion/autocomplete component for Vue.js. | ||
It supports v-model, allows custom styling, custom input and suggestion list templates, API calls and more. | ||
All of the props, events and slots are OPTIONAL for this component, so it can be used without any configuration at all. | ||
----- | ||
## Build Setup | ||
``` bash | ||
@@ -50,11 +62,12 @@ # clone the repo | ||
----- | ||
## Default Controls | ||
## What is it | ||
|Key | Description| | ||
|-|-| | ||
|`Escape` | If the suggestions list is shown - hide it.| | ||
|`ArrowDown` | If the suggestions list is hidden - show it.| | ||
|`ArrowUp`/`ArrowDown` | Cycle (hover) through suggestions.| | ||
|`Enter` | If the list is shown - chooses the highlighted element, if the list is hidden - refills the suggestions based on current input text.| | ||
|`Ctrl` + `Space` | Select the first element in the list.| | ||
This is a simple yet feature-rich suggestion/autocomplete component for Vue.js. | ||
It supports v-model, allows custom styling, custom input and suggestion list templates, API calls and more. | ||
All of the props, events and slots are OPTIONAL for this component, so it can be used without any configuration at all. | ||
----- | ||
@@ -76,2 +89,3 @@ ## Component API | ||
:destyled="false" | ||
:removeList="false" | ||
:filter-by-query="false" | ||
@@ -125,2 +139,3 @@ :value="defaultValue" | ||
| `destyled` | Boolean | `false` | Whether to cancel the default styling of input and suggestions list. | | ||
| `removeList` | Boolean | `false` | If true - the suggestion list will be always hidden. | | ||
| `filterByQuery` | Boolean | `false` | Whether to filter the resulting suggestions by input's text query (make it a search component). | | ||
@@ -127,0 +142,0 @@ | type, value, pattern, etc... | | | All of the HTML5 input attributes with their respected default values. | |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
23906
284
1