Added custom search function to List API doc - closes javve#678

sheffieldnikki · Apr 2, 2020 · 805e1bb · 805e1bb
1 parent cf4b090
commit 805e1bb
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/docs/api.html b/docs/api.html
@@ -272,7 +272,7 @@ <h3><a name="methods" class="anchor" href="#methods"></a>Methods</h3>
 
   </li>
   <li>
-    <p><strong><a name="search" class="achor" href="#search"></a>search(searchString, columns)</strong><br>
+    <p><strong><a name="search" class="achor" href="#search"></a>search(searchString, columns, searchFunction)</strong><br>
       Searches the list</p>
 
 <pre><code class="javascript">itemsInList = [
@@ -285,7 +285,20 @@ <h3><a name="methods" class="anchor" href="#methods"></a>Methods</h3>
 
 listObj.search(); // Show all items in list
 
-listObj.search('Jonny', ['name']); // Only search in the 'name' column</code></pre>
+listObj.search('Jonny', ['name']); // Only search in the 'name' column
+
+listObj.search('Jonny', searchFunction); // Custom search for Jonny
+
+listObj.search('Jonny', ['name'], searchFunction); // Custom search in the 'name' column</code></pre>
+<p>The optional <code>searchFunction</code> should be of the form:</p>
+
+<pre><code class="javascript">function searchFunction(searchString, columns) {
+  for (var k = 0, kl = listObj.items.length; k &lt; kl; k++) {
+     listObj.items[k].found = false;
+     // Insert your custom search logic here, set found = true
+
+  }
+};</code></pre>
 
   </li>
   <li>