iHwy jquery listnav plugin - list navigation for ordered and unordered lists

Demo 1
Demo 2
Demo 3
Demo 4
Demo 5
Demo 6

Using defaults and a jQuery ID selector

This is the easiest way to use the plugin. None of the default options are overridden and a jQuery ID selector is used to bind the plugin to a single list. View the listnav.css file to see the core CSS we used for this and the other demos.


  $('#demoOne').listnav();

Overriding some defaults and binding to multiple lists

A jQuery class selector is used to bind to two lists. The 'includeAll' default option is overridden, which causes the ALL link to be hidden and the first letter with matches to get pre-selected. The 'noMatchText' default is overridden, providing a custom message for letters with no matching results.

Code:


  $('.demoTwo').listnav({
    includeAll: false, 
    noMatchText: 'There are no matching entries.'
  });

Using an OL instead of a UL, setting the initLetter and different CSS styling

The 'initLetter' option is set to letter 'c', which forces the list to load with that letter selected. The list is an OL (ordered list) and the numbers restart at 1 under each letter. The default listnav.css styling is overridden (see the #demoThree segments in the file) to give the navigation and list a different look.


  $('#demoThree').listnav({
    initLetter: 'c'
  });

Floating boxes and no number navigation

Anchor (A) tags in the list items are styled to look like boxes and the LI's are floated left so that they will dynamically wrap from left to right and down. Take a look at the listnav.css file used in this page to see how it's done (look for #demoFour). The 0-9 number navigation item is hidden by the includeNums:false option.


  $('#demoFour').listnav({
    includeNums: false
  });

Using a session cookie and the onClick callback option

If you include the jquery.cookie js file in your page before the listnav js file, you can set the 'cookieName' option to have the listnav control remember your user's last clicked navigation item (the cookie value will be 'all', '_' for numbers 0-9 or a lowercase letter 'a' - 'z'). You can also use the 'onClick' callback to fire a custom function when a letter gets clicked. Click a letter to see the onClick function show you a message, then reload the page and come back to Demo 5 and you'll see that the list loads your last clicked letter (obtained from the cookie value).


  $('#demoFive').listnav({
    cookieName: 'ln-demo5',
    onClick: function(letter){
      alert('You clicked ' + ((letter == '_') ? '0-9' : letter.toUpperCase()) );
    }
  });

Using the includeOther and prefixes options.

Use the includeOther option to show a [...] navigation item for access to list items that start with something other than A-Z and 0-9 (such as Ä and Ü). If you'd like something like "The Valley News" or "The Willows Journal" to appear under V and W as well as under T, supply an array of prefixes using the prefixes option. Note: when using prefixes the ALL count will only include each item once.


  $('#demoSix').listnav({
    includeOther: true,
    prefixes: ['the','a']
  });

©2009 iHwy, Inc. For support, post to the jQuery Google Group with "listnav" in the subject line. No guarantees, but we monitor it regularly. Thanks to Web 2.0 Name Generator for some placeholder content. Tap into our jQuery skills for your project! Shoot us a message.