pfinkbeiner / quiqmenu.js

Usage

Setup Quiqmenu.js is really easy. Get the latest script from github and ensure you are using jQuery 1.3 or higher on your site.

After including the script you have to activate Quiqmenu.js with the following snippet.

<div id="menu"></div>

$(document).ready(function(){
  $("#menu").quiqmenu({
    use: 'h1, h2',
    brand: {
      enable: true,
      title: 'My Plugin'
    }
  });
});

Options

Of course you have the ability to customize your menu with a bunch of options.

name	type	default	description
id	string	'quiqmenu'	A unique identifier which will be append on generated menu.
use	string	'h1, h2'	Choose HTML tags which will be collected and used for your menu. Use syntax like »h1, h2, h4, h6«
brand	object	-	If the brand option is enabled it will appear an additional link which goes automatically to top on click.
brand.enable	boolean	true	If true, you should also fill brand.title with some string.
brand.title	string	'Quiqmenu.js'	Use your own brand title.
bootstrap	boolean	true	By default it uses style and markup from bootstrap. Can be turned off and script only creats an simply ul > li construct. You have to style it on your own.
smooth	boolean	true	If false it jumps to section without smooth scrolling effect.

ToDos

• Adding scrollspy. A feature which detects manually scrolling and highlights the current section.
• Use images in brand title.

Licence

Quiqmenu.js by Patrick Finkbeiner is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.