“Infinite Grid Pro ” Documentation by FWDesign


Infinite Grid Pro

Created: 01/08/2014
By:© FWD (Future Web Design)
Email: contact@webdesign-flash.ro

Thank you for purchasing our script. If you have any questions that are beyond the scope of this help file, please feel free to email via our email. Thanks so much!


Table of Contents

  1. IMPORTANT NOTES - read this before anything else
  2. Preparing thumbnails and images
  3. Infinite Grid Pro installation
  4. Constructor parameters
  5. Setup categories / playlists
  6. Setup Facebook share button
  7. API specifications
  8. Sources and Credits

A) IMPORTANT NOTES - make sure you read this! - top

Please note that the IGP installation and configuration is not complicated but because it has a lot of customizable settings it might seem complicated, please go through the entire documentation before trying to install it into your own page. Basically what it must be done is to copy some html and js code from the examples we provided and paste it into your own html page and of course add your own content.

If you want to use video or audio only mp4 or mp3 files are required. It will work in all browsers on desktop machines or mobile devices, this is extremely important because there is no need to create multiple audio or video formats for browsers that don't support mp4 or mp3, also please note that the mp4 and mp3 video aud audio formats are recommended and used by all major browsers distributors like Google, Microsoft, Apple, Mozilla etc.!

The server is character case sensitive so make sure that the IGP settings are identical to those from the provided examples.

IGP requires a minimum of 9 thumbnails in each category.

In the examples provided as reference we have used only 9 images per category to keep it simple and understandable this is why the thumbnails are repeating so often, the more thumbnails are added in the playlist the less there is a chance of the same thumbnail to repeat.

When something is wrong with a IGP action a red info box with the problem description will appear at the window top left corner, please note that this box is there to help you understand the problem, for example if an image is not found the box will appear and inform you about the problem. The box will hide when navigating to another item.

The IGP skin is constructed from png images. We have included psd files just in case you want to modify the skin. If you want a different skin the .png files must be modified. We have a great designer in our team so if you need a custom skin please contact us!

B) Preparing thumbnails and images! - top

Coding this grid was a challenge, first because the logic behind the code is complex and second and the most difficult part is that IGP is pushing the browser capabilities to its limits, it was extremely difficult to make it work. We strongly advice to use the same thumbnail and image settings and sizes that we've used. Inside the IGP constructor set the thumbnailMaxWidth:210 and thumbnailMaxHeight:190, these parameters represent the maximum initial thumbnails width and height when the thumbnails are first showed and the scale is 1 (no scale). Make sure that your thumbnails images width is 308px and the height is 206px, of course they can be modified but if the thumbnails width or height are higher then 320px in Chrome some rendering glitches can appear if there are too many image pixels to render, the other browsers are working fine no matter what sizes are used. The large images the ones that are showed using the lightbox make sure that they are not larger than 1500px in width or height, again you can use higher resolution images but it will make the grid slower.

If you want to use your own custom size thumbnails they should be saved as follow, first set the thumbnailMaxWidth and thumbnailMaxHeight parameters to your desired thumbnails size, based on this the thumbnails images must be saved as follows, width = thumbnailMaxWidth * 1.4 and height = thumbnailMaxHeight * 1.4 (this parameters represents the maximum initial thumbnails width and height when the thumbnails are first showed and the scale is 1 (no scale)).

C) Infinite Grid Pro installation - top

IGP has multiple display types (fluid width, responsive, fixed, fullscreen, after parent), each display type is explained in detail below.

Responsive installation

In the download files there is a start folder and in this folder there are example html files for each display type. You can use one of them to copy and paste the required html and js code based on the skin and display type that you need. In this tutorial we have used the responsive-minimal-skin.html file.

This is how IGP is installed in a HTML page, please read the Constructor parameters section, it will explain all settings in details.

Fluid width installation

This display type is resizing IGP width to fill the available browser width and keep the height fixed or fluid based on the maxWidth and autoScale properties. To use this display type follow the same installation steps from Responsive installation section, the only difference is the displayType property which must be set to fluidWidth like this displayType:fluidWidth. In the start folder there are two html files whose names are starting with fluid-width, you can use them as reference.

Fullscreen installation

This display type is resizing IGP width and height to fill the available browser viewport. To use this display type follow the same installation steps from Responsive installation section, the only difference is the displayType property which must be set to fullScreen like this displayType:fullScreen. In the start folder there are two html files whose names are starting with fullscreen, you can use them as reference.

Atter parent installation

This display type is resizing IGP width and height to fill the available parent div width and height, this is really useful if you have a responsive div and you want IGP to resize based on it's size. To use this display type follow the same installation steps from Responsive installation section, the only difference is the displayType property which must be set to afterParent like this displayType:afterParent. In the start folder there are two html files whose names are starting with after-parent, you can use them as reference.

D) Constructor parameters - top

Please open responsive-minimal-skin.html with a text editor as reference. These parameters represents the possible setting of IGP, they are all described below.

		

//main settings //combobox settings //ligtbox settings

E) Setup categories / playlists - top

Please open with a text editor the responsive-minimal-skin.html file as reference.

In this section is explained how to setup a playlist with two categories. There are 9 content types (image, video, audio, youtube, vimeo, flash, google maps, iframe, link) that the IGP lightbox can display and they are explained in detail below in this section. To add / remove items in the playlist add or remove items depending of the type that you need. Below is a representation of a playlist with two categories. Please note that at least 9 playlist items must be present in a playlist. To add a category add inside the playlist div an ul element with the attribute data-category-name. To remove a category delete the ul element with the attribute data-category-name and it's content that is not required any more.

As it can be seen the playlist is created using ul and li html elements with some custom attributes, what is important to note is that the playlist must have an unique id, this id is required by IGP and it must be set to the playlistId property like this playlistId:"myPlaylist".

			

Image type:

The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the image path. If you don't need description leave the inner html empty in this case remove the inner div.

		
  • Infinite Grid Pro

    Multimedia infinite grid for your website that can only be found on sale here, it runs on all major browsers and mobile devices like iPhone, iPad, IOS, Android and Windows8.



  • Video (mp4) type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the video path, IGP supports two video paths, one for desktop and one for mobile, this is useful if you want a large hd video for desktop and a smaller video version for mobile, the paths are separated by comma, the mobile video path is optional. The data-poster-path attribute represents the poster path, IGP supports two poser paths, one for desktop and one for mobile, the paths are separated by comma, the mobile poster path is optional. If you don't need description leave the inner html empty in this case remove the inner div.

    			
  • Revolution Lightbox, think outside the lightbox!

    Full blown multimedia responsive lightbox included, it runs on all major browsers and mobile devices like iPhone, iPad, iOS, Android and Windows8. It has support for image, video (mp4), audio (mp3), Vimeo, YouTube, iFrame, Google maps and flash.



  • Audio (mp3) type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the mp3 path, the data-width represents the maximum audio player width. If you don't need description leave the inner html empty in this case remove the inner div.

    			
  • Support for unlimited categories!

    Supports unlimited categories and each categories can have unlimited content.



  • Youtube type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the youtube video url. The data-width and data-height represents the maximum video width and height. If you don't need description leave the inner html empty in this case remove the inner div.

    			
  • Customizable thumbnails action

    When a thumbnail is pressed you can choose to do nothing, display multimedia content using our great revolution lightbox, or to open a new webpage. The lightbox has support for image, video (mp4), audio (mp3), Vimeo, YouTube, iFrame, Google maps and flash.



  • Vimeo type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the vimeo video url. The data-width and data-height represents the maximum video width and height. If you don't need description leave the inner html empty in this case remove the inner div.

    			
  • Outstanding performance using OOP code and CSS3

    High performance using OOP code and the latest CSS3 techniques, ready for mobile with swipe and pinch support, very flexible, easy to setup and extremely customizable.



  • Flash type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the flash swf path. The data-width and data-height represents the maximum item width and height. If you don't need description leave the inner html empty in this case remove the inner div.

    		
  • Support for four display types

    Support for four display types, responsive, fixed, fullscreen and fluid width.



  • Google maps type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the google maps url. The url can be created at this link, google provided a tool to create maps, just add your location and an embed code will be generated, from the embed code copy the src value and paste it as a value of the data-url attribute. The data-width and data-height represents the maximum item width and height. If you don't need description leave the inner html empty in this case remove the inner div.

    		
  • Customizable thumbnails action

    When a thumbnail is pressed you can choose to do nothing, display multimedia content using our great revolution lightbox, or to open a new webpage. The lightbox has support for image, video (mp4), audio (mp3), Vimeo, YouTube, iFrame, Google maps and flash.



  • Iframe type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the url of the page to load in the iframe. The data-width and data-height represents the maximum item width and height. If you don't need description leave the inner html empty in this case remove the inner div.

    		
  • Optional drop down categories menu

    Optional drop down categories menu, this categories selector can be positioned on the left or right side of the grid canvas.



  • Link type:

    The data-thumbnail-path attribute represents the thumbnail path, the data-url attribute represents the url the web page to open when the thumbnail is clicked, the data-target attribute represents the url target (_self or _blank). The data-width and data-height represents the maximum item width and height. If you don't need description leave the inner html empty in this case remove the inner div.

    		
  • Optional drop down categories menu

    Optional drop down categories menu, this categories selector can be positioned on the left or right side of the grid canvas.



  • F) Setup Facebook share button - top

    In order for the facebook share button to function a facebook app key is required, this key is obtained by setting up a facebook app as follows:

    One important thing to note is that the Infinite Grid Pro domain name must be identical with the url passed to the facebook app, for example if the Infinite Grid Pro domain name is http://www.some-domain.com and the facebook app is configured with the url/domain name http://some-domain.com it will not work, both url / domain names must be exactly the same.

    G) API specifications - top

    Inside the start file there is HTML file called API-example.html, open it with a text editor as reference. Below is a table with all API events and methods.

    Methods:

    Name Method Description

    getCategoryName

    getCategoryName(categoryId:int):String Returns the current category name, it has an optional parameter that allows to get the category name based on id, for example if you need the second category name this method can be called like this myIGP.getCategoryName(1);.

    getCategoryId

    getCategoryId():Number Returns the current category id, starting from 0 (zero).

    Event listeners:

    Event Prefix Description
    ready FWDIGP.READY Dispatched when IGP API is ready to be used.
    categoryUpdate FWDIGP.CATEGORY_UPDATE Dispatched when IGP a category is changed.
    showStart FWDIGP.LIGHTBOX_SHOW_START Dispatched when IGP lightbox starts to show.
    showComplete FWDIGP.LIGHTBOX_SHOW_COMPLETE Dispatched when IGP show animation is complete.
    hideStart FWDIGP.LIGHTBOX_HIDE_START Dispatched when IGP lightbox starts to hide.
    hideComplete FWDIGP.LIGHTBOX_HIDE_COMPLETE Dispatched when IGP hide animation is complete.

    H) Sources and Credits - top

    This plugin was made by Tibi from FWD (FWDesign) Future Web Design, for more information and support contact us at contact@webdesign-flash.ro

    Once again, thank you so much for purchasing this item. As I said at the beginning, I'd be glad to help you if you have any questions regarding this Infinite Grid Pro and I'll do my best to assist.

    FWDesign

    Go To Table of Contents