Coder Social home page Coder Social logo

cshenoy / jquery.birdseye Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ehmorris/jquery.birdseye

1.0 2.0 0.0 106 KB

A jQuery plugin that automatically generates birdseye navigation for a content container

Home Page: http://ehmorris.github.com/jQuery.birdseye/

jquery.birdseye's Introduction

jQuery.birdseye

About

jQuery.birdseye will read a content container and create a minified, birdseye version which shows the container's children elements in a navigable list, and the location of the user's viewport.

It's ideal to use on a content area with lots of subsections, like a long quiz or a long form.

To Use

  • copy dataset.js, birdseye.js, and birdseye.css somewhere into your project
  • link to jquery, jquery UI, dataset.js, and birdseye.js in that order in your <head>
  • link to birdseye.css somewhere in your <head>
  • place a div, section, or aside into your document with the class of .birdseye
  • on page load, call the birdseye function on the element for which you want birdseye navigation
$(function() {
  $('.container').birdseye();
});

Options

You can currently set the child element from which birdseye will create its sections, and the element which it will read for the section's title.

These values currently default, respectively, to "div", "h2".

Here's an example of overriding the default values:

$(function() {
  $('.container').birdseye({
    'child_element' : 'section.class',
    'title_element' : 'h1.title'
  });
});

Note: birdseye.css applies default styles to the .birdseye container - it sets a width, and position:fixed;

Check back or "watch" for updates!

jquery.birdseye's People

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.