diff --git a/libraries/LiveFilter/js/jquery.liveFilter.js b/libraries/LiveFilter/js/jquery.liveFilter.js index cf3b74950c7f6ad60f30ac52d93fb35aaa9389e1..46544b36350d5831bc683de335d61d30a9d35a0b 100755 --- a/libraries/LiveFilter/js/jquery.liveFilter.js +++ b/libraries/LiveFilter/js/jquery.liveFilter.js @@ -11,6 +11,18 @@ 2) https://github.com/mikemerritt/LiveFilter/pull/15 */ +/** + * Livefilter from a input box + * --- + * A simple dom-based search/filter utility. For more guidance, see: + * https://www.ebi.ac.uk/style-lab/websites/patterns/live-filter.html + * @param {element} actedOnItem + * @example + * $('#livefilter-element').liveFilter({ + * delay: 200, // don't log small changes + * analyticsLogging: true + * }); + */ (function($){ $.fn.liveFilter = function (settings) { // Default settings