Add menuItemLimit to README and types (#447)

* Add menuItemLimit to README * Add menuItemLimit to tributejs.d.ts
zurb · Jun 6, 2020 · 2a21d85 · 2a21d85
1 parent 99e4a3d
commit 2a21d85
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -200,6 +200,9 @@ Collection object shown with defaults:
     skip: false // true will skip local search, useful if doing server-side search
   },
 
+  // Limits the number of items in the menu
+  menuItemLimit: 25,
+
   // specify the minimum number of characters that must be typed before menu appears
   menuShowMinLength: 0
 }

diff --git a/tributejs.d.ts b/tributejs.d.ts
@@ -71,6 +71,9 @@ export type TributeCollection<T extends {}> = {
   // Customize the elements used to wrap matched strings within the results list
   searchOpts?: TributeSearchOpts;
 
+  // Limits the number of items in the menu
+  menuItemLimit?: number;
+
   // require X number of characters to be entered before menu shows
   menuShowMinLength?: number;
 };