diff --git a/README.rdoc b/README.rdoc index 1f4fe6b..02e83fe 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,6 +1,98 @@ == JqgridForRails -TODO: Introduction. +This is a simple plug-in to create JqGrid(http://www.trirand.com/blog) javascript code easily and cleaner inside rails views. + +== Example + +There is an example application at: + +== Views + +To generate the grid, you can first create a method in a helper and then call the +jqgrid+ method to generate the java script code. For example, if you have an invoices_helper.rb file, you can define a method there: + + include JqgridsHelper + + def invoices_jqgrid + + options = {:html_tags => true} + grid_options = { + :url => '/invoices', + :datatype => 'json', + :mtype => 'GET', + :colNames => ['Inv No','Date'], + :colModel => [ + { :name => 'invid', :index => 'invid', :width => 55 }, + { :name => 'invdate', :index => 'invdate', :width => 90 }, + ], + :pager => '#invoices_pager', + :rowNum => 10, + :rowList => [10, 20, 30], + :caption => 'My first grid', + :onSelectRow => "function() { alert('Row selected!');}".to_json_var + } + + jqgrid 'invoices_list', options, grid_options + end + + +Now you can use the helper in the view: + + <%= raw(invoices_jqgrid) %> + +Or, if you are using Rails 2.3.x : + + <%= invoices_jqgrid %> + +This will result in something like: + +