jquery-tablesorter

jQuery tablesorter plugin for Rails

Simple integration of jQuery tablesorter (Mottie's fork) into the asset pipeline.

Current tablesorter version: 2.31.3 (2020-03-03) documentation

Any issue associated with the js/css files, please report to Mottie's fork.

Installation

Add this line to your application's Gemfile:

gem 'jquery-tablesorter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jquery-tablesorter

Requirements

It should work with Rails 3.2 and higher as well as with ruby 1.9.3 - 2.7.x. Each release is always tested with the latest version of both.

Usage

JavaScript files

In your application.js

//= require jquery-tablesorter

This will require all core jquery-tablesorter files. Please note: This loads only the core-widgets and will neither include the extracted widgets nor any files from the addons and extras directories. Those files must be required manually as shown below.

Or you can include single file with:

//= require jquery-tablesorter/jquery.metadata
//= require jquery-tablesorter/jquery.tablesorter
//= require jquery-tablesorter/jquery.tablesorter.widgets
//= require jquery-tablesorter/addons/pager/jquery.tablesorter.pager
//= require jquery-tablesorter/widgets/widget-repeatheaders
//= require jquery-tablesorter/parsers/parser-metric
//= require jquery-tablesorter/extras/jquery.quicksearch
//= require jquery-tablesorter/beta-testing/pager-custom-controls

Please note that files in the beta-testing directory might move into the stable tablesorter or get renamed with upcoming tablesorter releases and thus could have to be required in an updated way after upgrading this gem.

Stylesheet files

In your application.css

/*
 *= require jquery-tablesorter/<theme name>
 */

Avaliable theme names:

• theme.black-ice
• theme.blue
• theme.bootstrap
• theme.bootstrap_2
• theme.dark
• theme.default
• theme.dropbox
• theme.green
• theme.grey
• theme.ice.css (file extension required due to sprockets, see issue #3)
• theme.jui
• theme.metro-dark

Pager theme:

/*
 *= require jquery-tablesorter/addons/pager/jquery.tablesorter.pager
 */

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Added some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request

Update js and css files

• Update tablesorter submodule
• Run rake jquery_tablesorter:update
• Run rake jquery_tablesorter:sanitize_image_paths
• Update README.md and CHANGELOG.md

Licensing

• Licensed under the MIT license.
• Original jquery-tablesorter code is dual licensed under the MIT and GPL licenses (see Mottie's fork).