Package Exports

bigpicture

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bigpicture) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

BigPicture.js

alt text

Super lightweight (just over 4 KB minified, 2 KB gzip) and framework independent JavaScript image / video viewer.

Supports Youtube, Vimeo, and direct video links.

Check out the example page here

Instructions

Install via npm or add a script from the dist directory to your page.

npm install bigpicture

var BigPicture = require('bigpicture');

Or with a script tag:

<script src="BigPicture.js"></script>

The script is all that's needed -- no additional CSS file.

When you want to open something, pass an object to BigPicture containing the element from which you want the animation to start and an optional second parameter depending on what you want to do. Examples below use this to refer to the trigger element being interacted with in the context of an event handler. You can use a different element if you want (for example, different buttons could be set up to open videos from the same central showcase element).

Remote image example

BigPicture({
  el: this,
  imgSrc: 'http://yourimage.jpg'
});

Remote video

BigPicture({
  el: this,
  vidSrc: 'http://yourvideo.mp4'
});

Youtube

Pass in the video ID from the url. For example, the ID for https://www.youtube.com/watch?v=z_PeaHVcohg would be z_PeaHVcohg (The v parameter in the address).

BigPicture({
  el: this,
  ytSrc: 'z_PeaHVcohg'
});

Vimeo

Like Youtube, pass in the video ID from the url. The ID for https://vimeo.com/119287310 would be 119287310.

BigPicture({
  el: this,
  vimeoSrc: '119287310'
});

Local images & background images

If your trigger element is an image or an element with a background image, you can open it directly by passing it alone.

BigPicture({
  el: this
});

Captions

To display a caption, add a caption attribute with the desired text (or HTML) to the trigger element itself.

<img src="yourimage.jpg" caption="Example of an optional caption."/>

Troubleshooting

If the media or loading icon fails to display, it's probably a z-index issue. The media container has a default z-index of 9999, and the loading icon has a z-index of 9 relative to the trigger element's parent container.

License: MIT