myusernamejeep / jquery.tocify.js Goto Github PK

A jQuery plugin that dynamically generates a table of contents. Tocify can be optionally styled with Twitter Bootstrap or jQueryUI Themeroller, and optionally animated with jQuery show/hide effects. Tocify also optionally provides support for smooth scrolling, scroll highlighting, scroll page extending, and the HTML5 pushstate API via History.js.

Homepage

Annotated Source Code

Notable Features

• Themeable with Twitter Bootstrap or jQueryUI Themeroller

• Supports dynamic scroll and click jQuery show/hide effects

• Supports HTML5 History pushstate API (via History.js) for forward and back button support

• Supports smooth scrolling animations

• Supports dynamic scroll highlighting

• Supports a page extender option to make sure a page is big enough to scroll to all table of content items

• Passes jsHint with no errors

##Requirements jQuery 1.7.2+

jQueryUI Widget Factory 1.8.21+

##Optional Dependencies History.js 1.7.1+

##Browser Support IE7+, Firefox 4+, Chrome, Safari 4+, and Opera 11+

##Unit Tests All unit tests are written using the Jasmine Framework (Work in Progress)

##Contributing Take care to maintain the existing coding style. Add Jasmine unit tests for any new or changed functionality. Lint and test your code using grunt.

If you plan to contribute to Tocify in the future, keep in mind that you should make sure your code passes the Grunt checks. If you are on Windows (like me) remember you need to run the grunt command using grunt.cmd. Also, if you have trouble getting the Jasmine Unit Tests to work with PhantomJS 1.5 (the current release), install PhantomJS 1.3.

After you have verified your code, send a pull request to the Tocify dev branch. After you send a pull request, you will hear back from me shortly after I review your code.

You'll find source code in the "src" subdirectory!

##Forking If you find that you need a feature that Tocify does not currently support, either let me know via the Tocify issue tracker, or fork Tocify on Github and easily extend it to create your own widget!

##Change Log

0.7.0 - September 24, 2012

• Fixed a nested element show/hide bug

0.6.0 - August 22, 2012

• Nested subheader element bug fixes

• Greatly improved showing/hiding deeply nested subheader elements

0.5.0 - August 21, 2012

• Added support for Twitter Bootstrap Theming
• Added the theme and extendPageOffset options.
• Removed the jqueryUI option BREAKING CHANGE
• Updated demo page to show off new Twitter Bootstrap theming

0.4.0 - August 19, 2012

• Added the setOption and setOptions methods
• Upgraded the CSS file
• Updated demo page

0.3.0 - August 15, 2012

• Added the showAndHide option.
• Bug fixes for when the jQuery history.js plugin is not used
• Upgraded the CSS file (removed unneccessary styles, etc.)
• Upgraded to jQueryUI 1.8.23.
• Upgraded to jQuery 1.8.0.
• Upgraded demo page

0.2.0 - July 16, 2012

• Added the scrollTo option. Upgraded to jQueryUI 1.8.21.
• Multiple bug fixes.
• Upgraded the project page (included in the demos folder) to use Twitter Bootstrap.

• I will soon move the demo page into it's own separate project to create a boilerplate for documenting open source projects.

0.1.0 - July 12, 2012

• Initial Tocify release. Added annotated source code and documentation

Contributors Greg Franko

Copyright (c) 2012 Greg Franko
Licensed under the MIT license.