From 4271b105313947d6b27ce5e1e19a680aeed33557 Mon Sep 17 00:00:00 2001 From: Kevin Brown Date: Sat, 14 Feb 2015 16:53:17 -0500 Subject: [PATCH] Add docs for three more options This adds documentation for the follow options - `minimumInputLength` - `maximumInputLength` - `minimumResultsForSearch` This closes https://github.com/select2/select2/issues/3035. --- docs/options.html | 110 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) diff --git a/docs/options.html b/docs/options.html index 242fc71b..08ea59c9 100644 --- a/docs/options.html +++ b/docs/options.html @@ -939,6 +939,116 @@ matcher: function (params, data) { boxes where only a single option can be selected.

+ + +

+ Sometimes when working with large data sets, it is more efficient to start + filtering the results when the search term is a certain length. This is + very common when working with remote data sets, as allows for only + significant search terms to be used. +

+ +
+
+
+
Key
+
minimumInputLength
+ +
Value
+
integer
+
+
+ +
+
+
Adapter
+
+ DataAdapter +
+ +
Decorator
+
+ MinimumInputLength +
+
+
+
+ + + +

+ In some cases, search terms need to be limited to a certain range. Select2 + allows you to limit the length of the search term such that it does not + exceed a certain length. +

+ +
+
+
+
Key
+
maximumInputLength
+ +
Value
+
integer
+
+
+ +
+
+
Adapter
+
+ DataAdapter +
+ +
Decorator
+
+ MaximumInputLength +
+
+
+
+ + + +

+ When working with smaller data sets, the search box can take up more space + that is necessary, as there are not enough results for filtering to be + effective. Select2 allows you to only display the search box when the + number of search results reaches a certain threshold. +

+ +
+
+
+
Key
+
minimumResultsForSearch
+ +
Value
+
integer
+
+
+ +
+
+
Adapter
+
+ DropdownAdapter +
+ +
Decorator
+
+ MinimumResultsForSearch +
+
+
+
+