Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

jquery shortcut key plugin

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 README.md
Octocat-spinner-32 jquery.beeline.js
README.md

About

jQuery Beeline

Beeline means take the most direct route. It's keyboard naviagation for web applications.

Based upon: http://github.com/jeresig/jquery.hotkeys

Requires

jquery-1.4.2

Use

Add the following to your $(document).ready(function(event)) area:

$(document).beeline();

Your links must have the class set as 'ajax' here is a typical link within a Rails app:

 <%= link_to "Products", products_path, :class => 'ajax', :target => 'content', :accesskey => 'f1' %>

This must have the following in your $(document).ready area to work

// Ajax navigation
$('a.ajax').live('click', function(e) { 
e.preventDefault();
link = $(this); 
target = link.attr('target')
$('#'+target).load(link.attr('href'), function() {});
});

Field Key Exceptions

If you would like to allow some keystrokes within text fields then you can add them as exceptions to the beeline function call like so:

$(document).beeline({field_keys: ['ctrl+b','f1','f2']});

No layout

Add the following to your application_controller

  # If the request is ajax then don't include a layout

  layout :no_xhr_layout

  def no_xhr_layout
    request.xhr? ? false : 'application'
  end

Note

Key combinations can only be put on links/buttons which have been binded to a click event.

Something went wrong with that request. Please try again.