diff --git a/Gruntfile.js b/Gruntfile.js index 6a037808..c2b9d8a0 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -168,7 +168,7 @@ module.exports = function (grunt) { grunt.registerTask('test', ['qunit:all']); // Custom task running QUnit tests for specified files. - // Usage: grunt test-only:test.html,test-help.html + // Usage example: grunt test-only:test.html,test-help.html grunt.registerTask('test-only', 'A task that runs only specified tests.', function(tests) { diff --git a/README.md b/README.md index d2b262db..6a440707 100644 --- a/README.md +++ b/README.md @@ -88,175 +88,5 @@ Find the complete documentation in the [WIKI](https://github.com/koalyptus/Table [MIT](LICENSE.md) -
Property | -Type | -Description | -Remarks | -Example | -
---|---|---|---|---|
target_id | -string | -defines the id of the container element that will contain the link/button showing / hiding filters row (default - null) | -- |
-var tfConfig = {
- extensions: [{
- name: 'filtersVisibility'
- target_id: 'my_container_id'
- }]
-};
- |
-
enable_icon | -boolean | -enable/disable default icon placed just before the link (default - true) | -- |
-var tfConfig = {
- extensions: [{
- name: 'filtersVisibility'
- target_id: 'my_container_id',
- enable_icon: false
- }]
-};
- |
-
btn_text | -string | -sets the text of the link showing / hiding filters row (default - '') | -- |
-var tfConfig = {
- extensions: [{
- name: 'filtersVisibility'
- target_id: 'my_container_id',
- enable_icon: false,
- btn_text: 'Filters'
- }]
-};
- |
-
btn_filters_row_visibility_html | -string | -defines the HTML of the button showing / hiding filters row (default -* null) | -note that the
-
- onclick event is added automatically
-to the html element and overwrites any eventual
-
- onclick
-attribute
-
- |
-
- var tfConfig = { btn_filters_row_visibility_html: '<button
-class="myCssClass">Expand/collapse filters</button>'
-}
- |
-
btn_filters_row_visibility_css_class | -string | -defines the css class of the link showing / hiding filters row (default -* 'btnExpClpFlt') | -- |
- var tfConfig = { btn_filters_row_visibility_css_class: 'myClass'
-}
- |
-
filters_row_visibility_css_class | -string | -defines the css class of the container (default - 'expClpFlt') | -- |
- var tfConfig = { filters_row_visibility_css_class: 'myClass'
-}
- |
-
filters_row_visibility_filters_table | -string | -If filters are in a separated table, this is the id of the filters -table (default - null) | -- |
- var tfConfig = { filters_row_visibility_filters_table: 'myTableId'
-}
- |
-
filters_row_visibility_filters_index | -number | -Only with external filters, this tells the scripts which row contains -the filters (default - 1) | -- |
- var tfConfig = { filters_row_visibility_filters_index: 1 }
- |
-
filters_row_visibility_at_start | -boolean | -if set false it will hide the filters row at extension first load | -- |
- var tfConfig = { filters_row_visibility_at_start: false }
- |
-
on_before_filters_row_is_displayed | -function | -calls defined function before filters row is displayed | -- |
- var tfConfig = { on_before_filters_row_is_displayed: function(o){
-alert(o.id); }
- |
-
on_after_filters_row_is_displayed | -function | -calls defined function after filters row is displayed | -- |
- var tfConfig = { on_after_filters_row_is_displayed: function(o){
-alert(o.id); }
- |
-
on_before_filters_row_is_hidden | -function | -calls defined function before filters row is hidden | -- |
- var tfConfig = { on_before_filters_row_is_hidden: function(o){
-alert(o.id); }
- |
-
on_after_filters_row_is_hidden | -function | -calls defined function after filters row is hidden | -- |
- var tfConfig = { on_after_filters_row_is_hidden: function(o){
-alert(o.id); }
- |
-