Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
76 lines (48 sloc) 1.92 KB

jquery-datatables-rails

This gem packages the jQuery DataTables plugin for easy use with the Rails 3.1+ asset pipleine.

It provides all the basic DataTables files, but not (yet) the extras.

Installation

  1. Add gem 'jquery-datatables-rails' to the assets group in your Gemfile and run bundle install.
  2. Add the JavaScript to application.js:

//= require dataTables/jquery.dataTables

  1. Add the stylesheets to application.css:

*= require dataTables/jquery.dataTables

Twitter Bootstrap 2 support

  1. Add the JavaScript to application.js:

//= require dataTables/jquery.dataTables.bootstrap

  1. Remove the initial stylesheets from application.css
  2. Add the stylesheets to application.css:

*= require dataTables/jquery.dataTables.bootstrap

  1. Initialize your datatables like this:
// For fluid containers
$('.datatable').dataTable({
  "sDom": "<'row-fluid'<'span6'l><'span6'f>r>t<'row-fluid'<'span6'i><'span6'p>>",
  "sPaginationType": "bootstrap"
});

// For fixed width containers
$('.datatable').dataTable({
  "sDom": "<'row'<'span6'l><'span6'f>r>t<'row'<'span6'i><'span6'p>>",
  "sPaginationType": "bootstrap"
});

Plugins

Only a few plugins are currently available

  • api
    • fnReloadAjax
    • fnGetColumnData
  • sorting
    • numbersHtml
  • typeDetection
    • numberHtml

Check out the assets directory.

Extras

Only a few extras are currently available:

  • FixedColumns
  • FixedHeader

To add an extra into your application, include it like follow:

//= require dataTables/extras/[ExtraName]

Make sure to also add it's initialization as described on datatables extras' site