picbookjs: A JavaScript repository from maheshmurthy

picbookJs

A simple Javascript library to display album photos from a Facebook Page.

Why?

The library was made because we wanted to easily "embed" photos from a Facebook page to our church's website. Also this would be managed by people with basic understanding of HTML, this is why I tried to keep it simple and without dependencies.

Installation

Download ZIP
Bower: bower install picbookjs

Getting Started

This is the simple way to get the ball rolling.

Basic usage

Create a <div class="picbook"></div> and include the picbook.min.js before the </body> tag. Then initialise the library passing an album ID:

<div class="picbook"></div>

<script type="text/javascript" src="picbook.min.js"></script>

<script type="text/javascript">
  (function($)){
    var picbook = new picbookJs({
      albumId: '10150167782373951'
    });
  })(jQuery);
</script>

Options

The follow options are available when you initialise:

Parameter	Description
albumId	The Facebook album ID (required)
albumLoaded	Callback a function as soon the album info is loaded
photosLoaded	Callback a function when all photos are loaded
limit	Number of photos to be loaded - The maximum allower by Facebook is 100
target	Element to load album into - Default is .picbook - Can be class or id

Example:

var options = {
  albumId: '10150167782373951',
  limit: 10,
  target: '#example',
  albumLoaded: function() { /* do something */ },
  photosLoaded: function() { /* do something else */ }
};

var picbook = new picbookJs(options);

Questions

Where do I get the album ID?

Go to an album page and copy the ID from the address bar URL:

How about retrieve an album that belongs to a user?

Not possible. The user_photo permission is required, which means you would have to create a Facebook app and implement the Facebook Login.

How about pagination?

This is in my TODO list. For now you can set the limit to 100.

License

The MIT License (MIT)

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.

maheshmurthy/picbookjs