Magnific-Popup on GitHub (dimsemenov/Magnific-Popup)

Magnific-Popup README

Important note This jQuery plugin is deprecated, only critical or security bug fixes will be released in future. Use native <dialog> element if you need a basic dialog/modal/popup, or my PhotoSwipe library if you need an advanced image gallery. Feel free to email me if you need assistance.

Fast, light and responsive lightbox plugin, for jQuery and Zepto.js.

Documentation and getting started guide.
Examples and plugin home page.
More examples in CodePen collection.

Optionally, install via Bower bower install magnific-popup or npm: npm install magnific-popup. Ruby gem: gem install magnific-popup-rails.

Extensions

If you created an extension for some CMS, email me and I'll add it to this list.

Location of stuff

Generated popup JS and CSS files are in folder dist/. (Online build tool is on documentation page).
Source files are in folder src/. They include Sass CSS file and js parts (edit them if you wish to submit commit).
Website (examples & documentation) is in folder website/.
Documentation page itself is in website/documentation.md (contributions to it are very welcome).

If you used Magnific Popup in some interesting way, or on site of popular brand, I'd be very grateful if you email me a link to it.

Build

To compile Magnific Popup by yourself, first of make sure that you have Node.js, Grunt.js, Ruby and Jekyll installed, then:

Copy repository

git clone https://github.com/dimsemenov/Magnific-Popup.git
Go inside Magnific Popup folder that you fetched and install Node dependencies

cd Magnific-Popup && npm install
Now simply run grunt to generate JS and CSS in folder dist and site in folder _site/.

grunt

Optionally:

Run grunt watch to automatically rebuild script when you change files in src/ or in website/.
If you don't have and don't want to install Jekyll, run grunt nosite to just build JS and CSS files related to popup in dist/.

Changelog

License

Script is MIT licensed and free and will always be kept this way. But has a small restriction from me - please do not create public WordPress plugin based on it(or at least contact me before creating it), because I will make it and it'll be open source too (want to get notified?).

Created by @dimsemenov & contributors.

Bugs & contributing

Please report bugs via GitHub and ask general questions through Stack Overflow. Feel free to submit commit pull-request, even the tiniest contributions to the script or to the documentation are very welcome.

11.3K ·GitHub

Magnific-Popup

What is this?

Magnific Popup is a lightweight JavaScript lightbox plugin built on jQuery that opens images, galleries, videos, inline content, or iframes in a responsive popup overlay, with a focus on keeping the script fast and small.

Is this a standalone app or a jQuery plugin I add to a page?

It is a client-side jQuery plugin: you drop its JS and CSS files into a page, and jQuery must be loaded for it to work.

Is this project still actively developed?

No, it is deprecated: only critical or security bug fixes will be released going forward, with no new features planned.

Can I still use this even though it's deprecated?

Yes, it still works and gets critical or security fixes, but no new features are coming; for a basic modal you might consider the native HTML dialog element instead.

Does it need jQuery to run?

Yes, Magnific Popup is written as a jQuery plugin, so jQuery must be loaded on the page alongside its JS and CSS files.

Can I turn this into a WordPress plugin?

The author asks you to contact him before publishing a public WordPress plugin based on Magnific Popup, since he intends to release an official one himself.

What are similar projects?

PhotoSwipe, slick, velocity, card, LearnCS8-Resume, interact.js, material, material-design-lite

Which topics is it in?

gallery, jquery, responsive, image, animation, deprecated, css, html, ui, web-development, npm, frontend

Creator: dimsemenov
Size: 1.9 MB
Stars: 11.3K
Updated: CommitJun 08 Release1.2.0Jun 08
Age: 13y
Commits · 90 Days