Rails Plugin Docs

The Fork Rails plugin has two parts. The first are helpers like fork_link_to_remote and fork_remote_form_for. The second part are methods for use with rjs templates (eventhough ejs templates are better!)

Note that this page documents Ruby functions to be called from inside a Ruby on Rails application. These Ruby functions wrap the Fork JavaScript functions. If you are not using Rails then this page will be of little interest. But surely you want to learn about Rails!

API

Similar to Rails' link_to_remote but with the Fork Ajax callbacks.

fork_form_remote_tag(options = {})

Similar to Rails' form_remote_tag but with the Fork Ajax callbacks.

fork_remote_form_for(object_name, *args, &proc)

Similar to Rails' remote_form_for but with the Fork Ajax callbacks.

fork_form_remote_for(object_name, *args, &proc)

Alias for fork_remote_form_for.

RJS API

Some of the core Rails' RJS functions are available for use without Prototype or Scriptaculous. You can freely use the following like you would normally: alert, redirect_to, call, assign, <<, delay.

Other RJS functions are only for use with Prototype and Scriptaculous however Fork does have equivalents of some of these already as documented below. Notice the Fork equivalents start with fork_ to avoid namespace clash and ease the transition to using Fork. The list of RJS function for use with Prototype and Scriptaculous are: [], select, insert_html, replace_html, replace, remove, show, hide, toggle, visual_effect, sortable, draggable, drop_receiving

fork_update(id, *options_for_render)

Analogous to Rails' replace_html.

Examples

page.fork_update 'myDiv', 'new content'

fork_replace(id, *options_for_render)

Analogous to Rails' replace.

Examples

page.fork_replace 'myDiv', '<div>new element</div>'

fork_insert(position, id, *options_for_render)

Analogous to Rails' insert_html.

Examples

page.fork_insert :bottom, 'myList', '<li>new item</li>'

fork_remove(*ids)

Analogous to Rails' remove.

Examples

page.remove 'myDiv', 'myListItem'