birdview

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 10 Open GitHub ↗

User interface experiment and JavaScript plugin.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Birdview.js

![Screenshot](https://raw.githubusercontent.com/AchrafKassioui/birdview/master/birdview_banner.png)

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

See [**demo & full documentation here**](https://www.achrafkassioui.com/birdview/).

## 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](https://www.gnu.org/licenses/gpl-3.0.en.html).

birdview

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README