MetalGuardian/yii2-fotorama-widget

DEPRECATED
==========
Unfortunately, original Fotorama gallery is no longer maintained. You still can use this extension if fotorama fits your project. 
Check [github thread](https://github.com/artpolikarpov/fotorama/issues/532) for alternatives.


Fotorama Yii2 widget
====================
This yii2 extension is a wrapper for the powerful jQuery gallery [Fotorama](http://fotorama.io/).

[![Latest Stable Version](https://poser.pugx.org/metalguardian/yii2-fotorama-widget/v/stable.svg)](https://packagist.org/packages/metalguardian/yii2-fotorama-widget)
[![Total Downloads](https://poser.pugx.org/metalguardian/yii2-fotorama-widget/downloads.svg)](https://packagist.org/packages/metalguardian/yii2-fotorama-widget)
[![Latest Unstable Version](https://poser.pugx.org/metalguardian/yii2-fotorama-widget/v/unstable.svg)](https://packagist.org/packages/metalguardian/yii2-fotorama-widget)
[![License](https://poser.pugx.org/metalguardian/yii2-fotorama-widget/license.svg)](https://packagist.org/packages/metalguardian/yii2-fotorama-widget)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/MetalGuardian/yii2-fotorama-widget/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/MetalGuardian/yii2-fotorama-widget/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/MetalGuardian/yii2-fotorama-widget/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/MetalGuardian/yii2-fotorama-widget/?branch=master)
[![Build Status](https://travis-ci.org/MetalGuardian/yii2-fotorama-widget.svg?branch=master)](https://travis-ci.org/MetalGuardian/yii2-fotorama-widget)
[![Code Climate](https://codeclimate.com/github/MetalGuardian/yii2-fotorama-widget/badges/gpa.svg)](https://codeclimate.com/github/MetalGuardian/yii2-fotorama-widget)

Installation
------------

Install this extension using [composer](http://getcomposer.org/download/).

```
composer require metalguardian/yii2-fotorama-widget
```

You should have configured `asset-packagist` repository in your project's `composer.json` or installed 
`fxp/composer-asset-plugin` plugin. For more information see [Yii2 bower/npm assets manual](http://www.yiiframework.com/doc-2.0/guide-structure-assets.html#bower-npm-assets)

Usage
-----

First way:

```php

    <?php 
    $fotorama = \metalguardian\fotorama\Fotorama::begin(
        [
            'options' => [
                'loop' => true,
                'hash' => true,
                'ratio' => 800/600,
            ],
            'spinner' => [
                'lines' => 20,
            ],
            'tagName' => 'span',
            'useHtmlData' => false,
            'htmlOptions' => [
                'class' => 'custom-class',
                'id' => 'custom-id',
            ],
        ]
    ); 
    ?>
        <img src="http://s.fotorama.io/1.jpg">    
        <img src="http://s.fotorama.io/2.jpg">
        <img src="http://s.fotorama.io/3.jpg">
        <img src="http://s.fotorama.io/4.jpg">
        <img src="http://s.fotorama.io/5.jpg">
    <?php \metalguardian\fotorama\Fotorama::end(); ?>

```

Second way:

```php

    <?php 
    echo \metalguardian\fotorama\Fotorama::widget(
        [
            'items' => [
                ['img' => 'http://s.fotorama.io/1.jpg', 'id' => 'id-one',],
                ['img' => 'http://s.fotorama.io/2.jpg',],
                ['img' => 'http://s.fotorama.io/3.jpg',],
                ['img' => 'http://s.fotorama.io/4.jpg',],
            ],
            'options' => [
                'nav' => 'thumbs',
            ]
        ]
    ); 
    ?>

```

To use CDNJS put this before run widget, will be used current version:

```php

    <?php \metalguardian\fotorama\Fotorama::$useCDN = true; ?>

```

Or select custom version:

```php

    <?php \metalguardian\fotorama\Fotorama::$useCDN = '4.5.0'; ?>

```

To setup default Fotorama widget options to all galleries on page:

```php

    <?php 
    \metalguardian\fotorama\Fotorama::setDefaults(
        [
            'nav' => 'thumbs',
            'spinner' => [
                'lines' => 20,
            ],
            'loop' => true,
            'hash' => true,
        ]
    );
    ?>

```

For complete documentation of Fotorama and all widget options please refer to the [official Fotorama page](http://fotorama.io/)

License
-------

**yii2-fotorama-widget** is released under the MIT License. See the bundled `LICENSE` for details.