Add documentation about tribute autocomplete.

zurb · Feb 27, 2019 · 1661350 · 1661350
1 parent 663313d
commit 1661350
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -186,6 +186,9 @@ Collection object shown with defaults:
   // when the spacebar is hit, select the current match
   spaceSelectsMatch: false,
 
+  // turn tribute into an autocomplete
+  autocompleteMode: false,
+
   // Customize the elements used to wrap matched strings within the results list
   // defaults to <span></span> if undefined
   searchOpts: {

diff --git a/bower.json b/bower.json
@@ -1,7 +1,7 @@
 {
   "name": "tribute",
   "description": "Native ES6 @mentions",
-  "version": "3.5.3",
+  "version": "3.6.0",
   "main": [
     "dist/tribute.js",
     "dist/tribute.css"

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tributejs",
-  "version": "3.5.3",
+  "version": "3.6.0",
   "description": "Native ES6 @mentions",
   "main": "dist/tribute.js",
   "types": "tributejs.d.ts",

diff --git a/tributejs.d.ts b/tributejs.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for TributeJS v3.5.3
+// Type definitions for TributeJS v3.6.0
 // Project: https://github.com/zurb/tribute
 // Definitions by: Jordan Humphreys <https://github.com/mrsweaters/>
 
@@ -53,6 +53,9 @@ export type TributeCollection<T extends {}> = {
 
   //specify whether the menu should be positioned
   positionMenu?: boolean
+
+  //specify whether to put Tribute in autocomplete mode
+  autocompleteMode?: boolean
 }
 
 export type TributeOptions<T> = TributeCollection<T> | {