https://github.com/kravse/shifter

A Ken Burns style automatic background image shifter.
https://github.com/kravse/shifter

Last synced: 14 days ago
JSON representation

A Ken Burns style automatic background image shifter.

• Host: GitHub
• URL: https://github.com/kravse/shifter
• Owner: kravse
• Created: 2015-09-03T02:50:28.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-30T17:03:11.000Z (about 9 years ago)
• Last Synced: 2024-12-23T19:52:14.015Z (21 days ago)
• Language: CoffeeScript
• Size: 3.29 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Background Shifter

===========

This is a little plugin that lets you add a rotating background to any div. This is not a user controlled slideshow, it's simply a rotating background. 

Instructions: 

1) In the project root, run 'npm install'

2) Run gulp to compile all static assets from 'src' into their build destinations. 

3) Optional: Run gulp watch to poll for changes. 

Setup the Background shifter

1) Include the shifter.js file. 

2) Add as many slides with the class .bg-shifter into any parent div. The shifter takes the height and width of the parent div, so you may need to style the parent appropriately. Each bg-shifter should have an inline style setting the background image. 

i.e. 

```



```


3) Initialize the shifter using Shifter.shift(object, time)(i.e. Shifter.shift($('.test-box'), 6000); )