Skip to content
User interface experiment and JavaScript plugin.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
birdview.css
birdview.js
birdview_banner.png

README.md

Birdview.js

Screenshot

Get a glance at a whole web page with an aerial view.

See demo & full documentation here.

Setup

Include birdview.js and birdview.css in HTML:

<link rel="stylesheet" type="text/css" href="birdview.css"/>
<script type="text/javascript" src="birdview.js"></script>

Then enable Birdview with the initialization method:

birdview.init();

Usage

To trigger birdview, you can either:

  • Press the Z key
  • Pinch-in on a touch device

You can also trigger birdview by clicking any HTML element with a birdview_toggle class:

<button class="birdview_toggle">Birdview</button>

Or you can toggle birdview programmatically using the toggle method:

birdview.toggle();

You can stop birdview from running on your page by calling:

birdview.destroy();

The destruction method is called inside the initialization method. Calling birdview.init() multiple times shouldn't create any undesirable overlapping.

License

Birdview.js is published under the GNU General Public License.

You can’t perform that action at this time.