Coder Social home page Coder Social logo

framescrub's Introduction

Project

FrameScrub is a plugin that mimics the iPhoto album/event mouseover functionality for the web.

Homepage http://www.mikcro.com/frameScrub

Project Setup

Setup is pretty easy...

  1. Download or clone the project.
  2. Include the project in your code. Make sure you have jQuery included also. It is in the project files or you can include the latest from Google.
<script src="js/jquery.1.11.0.min.js"></script>
<script src="js/frameScrub.min.js"></script>

Target an element like so...

$('#element').frameScrub({options});

The element should be set up something like this

<div id="element" style="width:100%;height:200px;overflow:hidden;">
  <img src="" id="1"/>
  <img src="" id="1"/>  
  <img src="" id="1"/>  
  <img src="" id="1"/>    
</div>

Here are the options...

Option What it do! Possible Values
defaultImage Takes the 'id' attribute of an image. On page load and mouseOut, the defaultImage will be what is displayed inside the frameScrub. "Element Id" : String
verticalAlignment Obviously, this will align the images vertically inside the frameScrub container. Align to the top, middle, or bottom. The default is top. "top": String
showTitles If you'd like to show titles of your images, you can do that. Just pass in the "ID" of the element you want to house the titles. Make sure your images have titles on them. "Element Id": String
frameWidth If you want to specify a width for your images, pass in this option. If you don't, the images will stretch to fit the container. Either way, the height will be calculated to preserve the image's aspect ratio. Also, if you don't pass any width, the frameScrub is responsive to widths. "width": String

What's Next

I wanted to release this and see if it gains any traction. Here is what is on my docket for improvements...

-Mobile friendliness very soon-

I am anxious to hear if people use it and want to see it improved. Also I welcome any bug reports.

License

The MIT License (MIT)

Copyright (c) 2014 Mike Cross

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

framescrub's People

Contributors

paulo72 avatar shumagorath86 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

framescrub's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.