Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 2.03 KB

README.md

File metadata and controls

77 lines (59 loc) · 2.03 KB

Elevate Zoom Widget for Yii2

An elevate zoom widget for Yii2 based on Elevate Zoom.

THIS IS A FORK OF amilna/yii2-elevatezoom DIFFERENCE: I have removed the thumbnail (aka gallery) options as I do not need that).

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require "gb5256/yii2-elevatezoom" "*"

or add

"gb5256/yii2-elevatezoom" : "*"

to the require section of your application's composer.json file.

Usage

in View

	use gb5256\elevatezoom\ElevateZoom;
 	
	$images = ['an url of zoom image 1','an url of zoom image n'];

	echo ElevateZoom::widget([
 		'images'=>$images,
		'baseUrl'=>Yii::$app->urlManager->baseUrl.'/upload',
		'smallPrefix'=>'/.thumbs',
		'mediumPrefix'=>'',
	]);

	/* //or another example set 'images' with 3 dimension array:
	$images'= [
		[	
			'image'=>'an url of zoom image 1',
			'small'=>'an url of gallery display image 1',
			'medium'=>'an url of basic display image 1'
		],
		[	
			'image'=>'an url of zoom image n',
			'small'=>'an url of gallery display image n',
			'medium'=>'an url of basic display image n'
		],
	];

	echo ElevateZoom::widget([
 		'images'=>$images,		
	]);
	*/


'images' is array of images (1 or 3 dimensions, if 1 dimensions then you should set baseUrl, smallPrefix and mediumPrefix) or activeDataProvider (if activeDataProvider you should set imageKey, smallKey and mediumKey)

available options:

  1. images
  2. css (custom css)
  3. baseUrl (string basic replacer of image url)
  4. smallPrefix (string replacer to get small size image url)
  5. mediumPrefix (string replacer to get medium size image url)
  6. imageKey (model atribute that store zoom size image)
  7. smallKey (model atribute that store small size image)
  8. mediumKey (model atribute that store medium size image)
  9. targetId (custom container id)
  10. options (please see examples)