Skip to content

JavaScript plugin to simplify the inclusion of full screen responsive YouTube video on your website.

License

Notifications You must be signed in to change notification settings

SQULS/Anamorph.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Anamorph.js

JavaScript plugin to simplify the inclusion of full screen responsive images and video on your website.

Usage

Include a reference to Anamorph.js in your index page.

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

Or the minimised verion.

<script src="anamorph.min.js"></script>

Anamorph is use be calling the anamorph() method and passing an object containing the following properties.

  • media: string, Url for image or video, or pass a YouTube url in https://www.youtube.com/embed/[VIDEO_ID] format
  • overlay: float/string (from 0 - 1), An opacity level for the overlay or 'bw' for black & white filter
  • random: boolean, If set start point will be randomised
  • start: (required if random is true) int, Start point in seconds
  • end: (required if random is true) int, End point in seconds
  • backup: string, Url for back up image

For example:

let properties = {
    media: 'https://www.youtube.com/embed/hpRQo0yD-FU',
    overlay: 0.5,
    random: true,
    start: 100,
    end: 300,
    backup: 'cloud.jpg'
}
        
anamorph(properties)

File formats supported are .jpg, .gif & .png for images and .mp4 for video.

As some mobile devices and tablets do not allow autoplaying of video it is always prudent to pass a backup image. Anamorph will detect what type of device you are using.

License

This project is Unlicensed - see the LICENSE file for details.

About

JavaScript plugin to simplify the inclusion of full screen responsive YouTube video on your website.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published