diff --git a/README.md b/README.md index 52fd477..a7d7987 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,52 @@ Grab the latest release from Github or install using bower: bower install jquery.tableCheckbox.js +## Features + +- Translates clicks on rows to their checkbox +- Supports master checkbox in the table header +- Supports selection of multiple rows by holding down the shift key +- No mess with text selections without the need to disable them. + The Plugin avoids getting in the way of the user if he wants to select / deselect text and tries to be smart about unwanted selections when selecting rows. + ## Usage - $('table').tableCheckbox(); + + + + + + + + + + + + + + + +
Name
First item
First item
+ + +You may use this plugin with other markup structures or ways of input. +Use the options below to make it fit your use case. + + ## Options - $('table').tableCheckbox({ /* options */ }) + $('table').tableCheckbox({ /* options */ }); ### selectedRowClass -Default: `'warning'` to comply with Bootstrap. +Default: `warning` to comply with Bootstrap. This class will be applied to any table row that is selected. ### checkboxSelector -Default: `'td:first-of-type input[type="checkbox"],th:first-of-type input[type="checkbox"]'` +Default: `td:first-of-type input[type="checkbox"],th:first-of-type input[type="checkbox"]` The jQuery selector used to find the checkboxes in the table.