https://github.com/devanb/datatables-rails-bs3

datatables bootstrap 3 for rails
https://github.com/devanb/datatables-rails-bs3

bootstrap bootstrap3 datatables rails rails-gem ruby

Last synced: 27 days ago
JSON representation

datatables bootstrap 3 for rails

• Host: GitHub
• URL: https://github.com/devanb/datatables-rails-bs3
• Owner: DevanB
• License: other
• Created: 2013-10-24T15:26:52.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-11-04T14:52:28.000Z (about 11 years ago)
• Last Synced: 2024-12-15T23:20:52.658Z (about 1 month ago)
• Topics: bootstrap, bootstrap3, datatables, rails, rails-gem, ruby
• Language: Ruby
• Homepage: https://rubygems.org/gems/datatables-rails-bs3
• Size: 695 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# datatables-rails-bs3

This gem packages the jQuery [DataTables](http://datatables.net/) plugin for easy use with the Rails 3.1+ asset pipleine.

It provides all the basic DataTables files, and a few of the extras.

## Twitter Bootstrap 3 Installation

1. Add to your Gemfile:

        gem 'datatables-rails-bs3'

1. Install the gem:

        bundle install

1. Add the JavaScript to `application.js`:

        //= require dataTables/jquery.dataTables

        //= require dataTables/jquery.dataTables.bootstrap

1. Add the stylesheets to `application.css`:

        *= require dataTables/jquery.dataTables.bootstrap

1. Initialize your datatables using one of these options:

```javascript

// Default Type

$('.datatable').dataTable({

  "sPaginationType": "bs_normal"

});

```

```javascript

// Two Buttons

$('.datatable').dataTable({

  "sPaginationType": "bs_two_button"

});

```

```javascript

// Four Buttons

$('.datatable').dataTable({

  "sPaginationType": "bs_four_button"

});

```

```javascript

// Full

$('.datatable').dataTable({

  "sPaginationType": "bs_full"

});

```

## Plugins

Only a few plugins are currently available

* api

    * fnReloadAjax

    * fnGetColumnData

    * fnFilterOnReturn

    * fnSetFilteringDelay

* sorting

    * numbersHtml

* typeDetection

    * numberHtml

These files can be found in the [assets directory][assets].

## Extras

Only the official extras are available:

* AutoFill

* ColReorder

* ColVis

* FixedColumns

* FixedHeader

* KeyTable

* Scroller

* TableTools

To add an extra into your application, add its JS file to `application.js` using the following pattern:

    //= require dataTables/extras/[ExtraName]

Additionally, you may need to add any associated CSS files. For instance the TableTools extra requires

you to add the following two lines to your `application.css` file:

    *= require dataTables/extras/TableTools

    *= require dataTables/extras/TableTools_JUI

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

[assets]: https://github.com/DevanB/jquery-datatables-rails/tree/master/vendor/assets/javascripts/dataTables

[datatables_extras]: http://datatables.net/extras/