README.md

JS Cloudimage 360 View

Docs • Demo • Code Sandbox • Why

A simple, interactive resource that can be used to provide a virtual tour of your product.

powered by Cloudimage (Watch the video here)

Table of contents

• Demo
• Step 1: Installation
• Step 2: Initialize
• Configuration
• Cloudimage responsive integration
• Lazy loading integration
• Best practices
• Browser support
• Filerobot UI Family
• Contributing
• License

Demo

To see the Cloudimage 360 view plugin in action, please check out the Demo page.

Step 1: Installation

Add script tag with CDN link to js-cloudimage-360-view lib after all content in body tag

<script src="https://cdn.scaleflex.it/filerobot/js-cloudimage-360-view/v2.0.0.min.js"></script>

Step 2: Initialize

After adding the js-cloudimage-360-view lib, simply iniatialize it with class name "cloudimage-360", server folder path, file name and amount of images:

<div
   class="cloudimage-360"
   data-folder="https://scaleflex.cloudimg.io/crop/1920x700/n/https://scaleflex.airstore.io/demo/360-car/"
   data-filename="iris-{index}.jpeg"
   data-amount="36"
></div>

Config

class

The selector for js-cloudimage-360-view lib.

data-folder (or folder)

Your images folder on server.

data-amount (or amount)

Amount of images to load for 360 view.

data-keys (or keys)

Support for 360 spin by pressing arrow keys on keyboard.

data-autoplay (or autoplay)

Autoplay 360 spin view on load.

data-full-screen (or full-screen)

Open 360 spin view in full screen modal.

data-magnifier (or magnifier)

Magnifier to zoom image.

data-ratio (or ratio)

Prevents page from jumping.

data-autoplay-reverse (or autoplay-reverse)

Autoplay 360 spin view on load.

data-speed (or speed)

Speed of changing frames in milliseconds.

data-box-shadow (or box-shadow)

Apply box shadow for container.

data-bottom-circle (or bottom-circle)

Display 360 view line at the bottom of container.

data-bottom-circle-offset (or bottom-circle-offset)

Bottom offset for 360 view line.

data-lazyload (or lazyload)

Only 360 view images close to the client's viewport will be loaded, hence accelerating the page loading time. If set to true, an additional script must be included, see Lazy loading

data-lazyload-selector (or lazyload-selector)

Helper class to apply lazy-loading depending on library you choose, see Lazy loading

Cloudimage Responsive Integration

See how it works (article on Medium)

Requirements

To use the Cloudimage Responsive plugin, you will need a Cloudimage token to deliver your images over CDN. Don't worry, it only takes seconds to get one by registering here. Once your token is created, you can configure it as described below. This token allows you to use 25GB of image cache and 25GB of worldwide CDN traffic per month for free.

data-responsive (or responsive)

Enables cloudimage responsive plugin for 360 view.

data-filters (or filters)

Applies default Cloudimage filters to your image, e.g. fcontrast, fpixelate, fgaussian, backtransparent, rotation... Multiple filters can be applied, separated by "." (dot).

Full documentation here.

Lazy Loading

Lazy loading is not included into js-cloudimage-360-view by default. There are well thought libraries to achieve that. If you enable lazy loading in the configuration, you need to add an additional library like lazysizes, yall.js (Yet Another Lazy Loader), lozad.js to handle it.

Implementation example with lazysizes

Implementation example with yall.js

Implementation example with lozad.js

to save API calls you man want to use one of our cdn bundles:

CDN link to js-cloudimage-360-view 1.1.0 + lazysizes 4.1.7

<script src="https://cdn.scaleflex.it/filerobot/js-cloudimage-360-view/v2.0.0.lazysizes.min.js"></script>

CDN link to js-cloudimage-360-view 1.1.0 + yall.js 3.1.1

<script src="https://cdn.scaleflex.it/filerobot/js-cloudimage-360-view/v2.0.0.yall.min.js"></script>

CDN link to js-cloudimage-360-view 1.1.0 + lozad.js 1.9.0

<script src="https://cdn.scaleflex.it/filerobot/js-cloudimage-360-view/v2.0.0.lozad.min.js"></script>

Best practices

Browser support

Tested in all modern browsers and IE 11, 10, 9.

Filerobot UI Familiy

• JS Cloudimage Responsive
• React Cloudimage Responsive
• Angular Cloudimage Responsive
• Image Editor
• Uploader

Contributing!

All contributions are super welcome!

License

JS Cloudimage 360 View is provided under the MIT License