https://github.com/webpop/jquery.pin

Pin any element within a container
https://github.com/webpop/jquery.pin

Last synced: 15 days ago
JSON representation

Pin any element within a container

• Host: GitHub
• URL: https://github.com/webpop/jquery.pin
• Owner: webpop
• Created: 2013-03-20T00:49:13.000Z (over 11 years ago)
• Default Branch: gh-pages
• Last Pushed: 2018-04-05T14:37:10.000Z (over 6 years ago)
• Last Synced: 2024-10-14T08:42:41.862Z (about 1 month ago)
• Language: CSS
• Size: 499 KB
• Stars: 1,276
• Watchers: 59
• Forks: 321
• Open Issues: 41
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## jQuery.pin

Ever wanted to **pin** something to the side of a text? Ever needed a subtle sticky element to quietly hang around as you scroll down?

**Jquery.Pin** is here to help! Pin any element to the top of a container. Easily **disable** it for smaller screen-sizes where there's no room for that kind of shenanigans.

## Usage

Include jquery and jquery pin at the bottom of your html. Then pin any element you want like this:

    $(".pinned").pin()

To make a pinned element stay within an outer container, use the containerSelector option:

    $(".pinned").pin({containerSelector: ".container"})

Padding can also be added around the pinned element while scrolling:

    $(".pinned").pin({padding: {top: 10, bottom: 10}})

That's it - go pin all the things!

## Examples

Plenty of examples [Here](http://webpop.github.com/jquery.pin/).

## License

Copyright (c) 2013, Mathias Biilmann

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.