diff --git a/README.markdown b/README.markdown index c3f71a0..2c0a381 100644 --- a/README.markdown +++ b/README.markdown @@ -11,56 +11,57 @@ A [jQuery][jquery_site] based plug-in for filtering large data sets with user in Note that the usage has changed in the latest version of quicksearch, the code is *not* backwards compatible, the form and input are not build by the script any more. - - $(input_selector).quicksearch(elements_to_search, options); - +```js +$(input_selector).quicksearch(elements_to_search, options); +``` #### Example on table rows - - /* Example form */ -
- -
- - /* Example table */ - - - - - - - -
Test cellAnother test cell
- - - - +```html +/* Example form */ +
+ +
+ +/* Example table */ + + + + + + + +
Test cellAnother test cell
+ + + + +``` #### Example on the `` elements on a table row - - $('input#search').quicksearch('table tbody tr', { - selector: 'th' - }); - +```js +$('input#search').quicksearch('table tbody tr', { + selector: 'th' +}); +``` #### Example of how to use with JS - - var qs = $('input#id_search_list').quicksearch('ul#list_example li'); - $('ul#list_example').append('
  • Loaded with Ajax
  • '); - qs.cache(); - +```js +var qs = $('input#id_search_list').quicksearch('ul#list_example li'); +$('ul#list_example').append('
  • Loaded with Ajax
  • '); +qs.cache(); +``` #### Example of how to use with Ajax - - var qs = $('input#search').quicksearch('table tbody tr'); - $.ajax({ - 'type': 'GET', - 'url': 'index.html', - 'success': function (data) { - $('table tbody tr').append(data); - qs.cache(); - } - }); - +```js +var qs = $('input#search').quicksearch('table tbody tr'); +$.ajax({ + 'type': 'GET', + 'url': 'index.html', + 'success': function (data) { + $('table tbody tr').append(data); + qs.cache(); + } +}); +``` ## Options * #### delay @@ -94,34 +95,34 @@ the form and input are not build by the script any more. For example: - - $('input#search').quicksearch('table tbody tr', { - 'delay': 100, - 'selector': 'th', - 'stripeRows': ['odd', 'even'], - 'loader': 'span.loading', - 'noResults': 'tr#noresults', - 'bind': 'keyup keydown', - 'onBefore': function () { - console.log('on before'); - }, - 'onAfter': function () { - console.log('on after'); - }, - 'show': function () { - $(this).addClass('show'); - }, - 'hide': function () { - $(this).removeClass('show'); - } - 'prepareQuery': function (val) { - return new RegExp(val, "i"); - }, - 'testQuery': function (query, txt, _row) { - return query.test(txt); - } - }); - +```js +$('input#search').quicksearch('table tbody tr', { + 'delay': 100, + 'selector': 'th', + 'stripeRows': ['odd', 'even'], + 'loader': 'span.loading', + 'noResults': 'tr#noresults', + 'bind': 'keyup keydown', + 'onBefore': function () { + console.log('on before'); + }, + 'onAfter': function () { + console.log('on after'); + }, + 'show': function () { + $(this).addClass('show'); + }, + 'hide': function () { + $(this).removeClass('show'); + } + 'prepareQuery': function (val) { + return new RegExp(val, "i"); + }, + 'testQuery': function (query, txt, _row) { + return query.test(txt); + } +}); +``` ## Help make quicksearch better! If you have a bug fix, the best way to help would be to: @@ -156,4 +157,4 @@ Thanks to [Seth F.][thelizardreborn] for fixes and [Krzysiek Goj][goj] for the [github_follow]: http://github.com/users/follow?target=riklomas [twitter_follow]: http://twitter.com/riklomas [thelizardreborn]: http://github.com/thelizardreborn -[goj]: http://github.com/goj \ No newline at end of file +[goj]: http://github.com/goj