You are here

Home » API reference » Magnific Popup 8

README.txt in Magnific Popup 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Features
 * Requirements
 * Recommended Modules
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

This module provides field formatters for the Magnific Popup jquery plugin by
Dmitry Semenov (https://github.com/dimsemenov/Magnific-Popup).
This plugin is ideal for creating pop-up galleries of pictures or videos.

The 8.x module is still under heavy development with new features being added
as they are thought of or suggested.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/magnific_popup

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/magnific_popup


FEATURES:
---------

Has different gallery types including:

 * 'First Item Only' - Display only one thumbnail from multiple images on the
   field, but all images can be viewed by navigating in the pop-up gallery.
 * 'Gallery - All Items' - Show all thumbnails and allow all items to be seen
   in the pop-up gallery.
 * 'Separate Items' - Show all thumbnails, but don't allow navigation to other
   items in the pop-up gallery. This only displays the clicked image in the
   pop-up.


REQUIREMENTS
------------

This module requires no modules outside of Drupal core.


RECOMMENDED MODULES
-------------------

Integration with Video Embed Field to provide pop-up videos for different
providers with various embed and auto-play options. Also has the gallery options
listed above available for the video thumbnails and galleries.

 * Video Embed Field - https://www.drupal.org/project/video_embed_field


INSTALLATION
------------

 * Install the third-party Magnific Popup library
   https://github.com/dimsemenov/Magnific-Popupas "magnific-popup" under
   DRUPAL_ROOT/libraries.
   To be correctly detected and used, the JS and CSS should be located at these
   paths:
   libraries/magnific-popup/dist/jquery.magnific-popup.min.js
   libraries/magnific-popup/dist/magnific-popup.css
   Paths not using the "dist" folder (for versions before 8.x-1.3) are still
   supported. Although it is advisable to update the paths to use the "dist"
   older.


CONFIGURATION
-------------

    1. Navigate to Administration > Extend and enable the module.
    2. Navigate to Administration > Structure > Content types > [Content type
       to edit] > Manage display.
    3. Choose "Magnific Popup" as the formatter and optionally configure
       Gallery Style options on an image or video embed field field.
    3. Save.

MAINTAINERS
-----------

 * Jay Dansand (jay.dansand) - https://www.drupal.org/u/jaydansand
 * Eric Goodwin (Eric115) - https://www.drupal.org/u/eric115
 * Drew Nackers (nackersa) - https://www.drupal.org/u/nackersa

License - MIT
Github - https://github.com/dimsemenov/Magnific-Popup

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Features

  6.  * Requirements

  7.  * Recommended Modules

  8.  * Installation

  9.  * Configuration

  10.  * Maintainers

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. This module provides field formatters for the Magnific Popup jquery plugin by

  17. Dmitry Semenov (https://github.com/dimsemenov/Magnific-Popup).

  18. This plugin is ideal for creating pop-up galleries of pictures or videos.

  19. 

  20. The 8.x module is still under heavy development with new features being added

  21. as they are thought of or suggested.

  22. 

  23.  * For a full description of the module, visit the project page:

  24.    https://www.drupal.org/project/magnific_popup

  25. 

  26.  * To submit bug reports and feature suggestions, or to track changes:

  27.    https://www.drupal.org/project/issues/magnific_popup

  28. 

  29. 

  30. FEATURES:

  31. ---------

  32. 

  33. Has different gallery types including:

  34. 

  35.  * 'First Item Only' - Display only one thumbnail from multiple images on the

  36.    field, but all images can be viewed by navigating in the pop-up gallery.

  37.  * 'Gallery - All Items' - Show all thumbnails and allow all items to be seen

  38.    in the pop-up gallery.

  39.  * 'Separate Items' - Show all thumbnails, but don't allow navigation to other

  40.    items in the pop-up gallery. This only displays the clicked image in the

  41.    pop-up.

  42. 

  43. 

  44. REQUIREMENTS

  45. ------------

  46. 

  47. This module requires no modules outside of Drupal core.

  48. 

  49. 

  50. RECOMMENDED MODULES

  51. -------------------

  52. 

  53. Integration with Video Embed Field to provide pop-up videos for different

  54. providers with various embed and auto-play options. Also has the gallery options

  55. listed above available for the video thumbnails and galleries.

  56. 

  57.  * Video Embed Field - https://www.drupal.org/project/video_embed_field

  58. 

  59. 

  60. INSTALLATION

  61. ------------

  62. 

  63.  * Install the third-party Magnific Popup library

  64.    https://github.com/dimsemenov/Magnific-Popupas "magnific-popup" under

  65.    DRUPAL_ROOT/libraries.

  66.    To be correctly detected and used, the JS and CSS should be located at these

  67.    paths:

  68.    libraries/magnific-popup/dist/jquery.magnific-popup.min.js

  69.    libraries/magnific-popup/dist/magnific-popup.css

  70.    Paths not using the "dist" folder (for versions before 8.x-1.3) are still

  71.    supported. Although it is advisable to update the paths to use the "dist"

  72.    older.

  73. 

  74. 

  75. CONFIGURATION

  76. -------------

  77. 

  78.     1. Navigate to Administration > Extend and enable the module.

  79.     2. Navigate to Administration > Structure > Content types > [Content type

  80.        to edit] > Manage display.

  81.     3. Choose "Magnific Popup" as the formatter and optionally configure

  82.        Gallery Style options on an image or video embed field field.

  83.     3. Save.

  84. 

  85. MAINTAINERS

  86. -----------

  87. 

  88.  * Jay Dansand (jay.dansand) - https://www.drupal.org/u/jaydansand

  89.  * Eric Goodwin (Eric115) - https://www.drupal.org/u/eric115

  90.  * Drew Nackers (nackersa) - https://www.drupal.org/u/nackersa

  91. 

  92. License - MIT

  93. Github - https://github.com/dimsemenov/Magnific-Popup