Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getgrav/grav-plugin-featherlight
Grav Featherlight Plugin
https://github.com/getgrav/grav-plugin-featherlight
grav grav-plugin lightbox
Last synced: about 2 months ago
JSON representation
Grav Featherlight Plugin
- Host: GitHub
- URL: https://github.com/getgrav/grav-plugin-featherlight
- Owner: getgrav
- License: mit
- Created: 2014-12-01T00:10:02.000Z (about 10 years ago)
- Default Branch: develop
- Last Pushed: 2021-11-15T02:15:13.000Z (about 3 years ago)
- Last Synced: 2024-10-30T02:06:04.666Z (2 months ago)
- Topics: grav, grav-plugin, lightbox
- Language: PHP
- Homepage: https://getgrav.org
- Size: 592 KB
- Stars: 30
- Watchers: 8
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Grav Featherlight Plugin
`featherlight` is a simple [Grav](https://github.com/getgrav/grav) plugin that adds **lightbox** functionality via the jQuery plugin [Featherlight.js](https://noelboss.github.io/featherlight/).
# Installation
Installing the Featherlight plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
## GPM Installation (Preferred)
The simplest way to install this plugin is via the [Grav Package Manager (GPM)](https://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line). From the root of your Grav install type:
bin/gpm install featherlight
This will install the Featherlight plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/featherlight`.
## Manual Installation
To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `featherlight`. You can find these files either on [GitHub](https://github.com/getgrav/grav-plugin-featherlight) or via [GetGrav.org](https://getgrav.org/downloads/plugins#extras).
You should now have all the plugin files under
/your/site/grav/user/plugins/featherlight
>> NOTE: This plugin is a modular component for Grav which requires [Grav](https://github.com/getgrav/grav) to function
# Usage
To best understand how Featherlight works, you should read through the original project [documentation](https://github.com/noelboss/featherlight/#installation).
## Configuration
Featherlight is **enabled** but **not active** by default. You can change this behavior by setting `active: true` in the plugin's configuration. Simply copy the `user/plugins/featherlight/featherlight.yaml` into `user/config/plugins/featherlight.yaml` and make your modifications.
```yaml
enabled: true # global enable/disable the entire plugin
active: false # if the plugin is active and JS/CSS should be loaded
openSpeed: 250 # open speed in ms
closeSpeed: 250 # close speed in ms
closeOnClick: background # background|anywhere|false
closeOnEsc: true # true|false on hitting Esc key
root: body # where to append featherlights
initTemplate: plugin://featherlight/js/featherlight.init.js
```
You can also override any default setings from the page headers:
eg:
```yaml
---
title: Sample Code With Custom Settings
featherlight:
active: true
openSpeed: 100
closeSpeed: 100
---
```
You can also enable globally in the `yaml`, but disable featherlighting for a particular page:
```yaml
---
title: Sample Code with Featherlight disabled
featherlight:
active: false
---
```
## Implementing a lightbox with Featherlight
To implement a lightbox using Featherlight in Grav, you must output the proper HTML output. Luckily Grav already takes care of this for you if you are using Grav media files.
In markdown this could look something like:
```md
```
In Twig this could look like:
```twig
{{ page.media['sample-image.jpg'].lightbox(1024,768).cropResize(200,200).html('Sample Image') }}
```
More details can be found in the [Grav documentation for Media functionality](https://learn.getgrav.org/content/media).
>> NOTE: Featherlight does not support [`srcset`](https://github.com/noelboss/featherlight/issues/337).
## Adding captions to the lightbox
Image captions within the lightbox do not come out of the box with featherlight. But as the author described in his [wiki](https://github.com/noelboss/featherlight/wiki/Gallery:-showing-a-caption) it's quite easy to add.
Per default we use a this script when initializing the plugin: [js/featherlight.init.js](js/featherlight.init.js). You can copy it to the "user" folder, change the initTemplate setting to `user://js/featherlight.init.js` and add a afterContent callback like this:
```js
$(document).ready(function(){
$('a[rel="lightbox"]').{pluginName}({
openSpeed: {openSpeed},
closeSpeed: {closeSpeed},
closeOnClick: '{closeOnClick}',
closeOnEsc: '{closeOnEsc}',
root: '{root}',
afterContent: function() {
var caption = this.$currentTarget.find('img').attr('alt');
this.$instance.find('.caption').remove();
$('
').text(caption).appendTo(this.$instance.find('.featherlight-content'));
}
});
});
```
The placeholders `{pluginName}`, `{openSpeed}`, `{closeSpeed}` and `{root}` will be replaced when processing this file.
## Using AMD modules with RequireJS
Must update to `v1.4.1`. When you select `RequireJS` from the config, this plugin will inlineJS an AMD module called `featherlight` that you can use with RequireJS. If you call this module directly, it will work, however if you decide to disable this plugin RequireJS will fail. As such, if you include the module below it will see if `featherlight` exists and include it if it does.
```js
define(['jquery'], function($){
var Lightbox = {
Init : function() {
if (require.specified('featherlight')) {
require( [ 'featherlight' ], function (Featherlight) {
Featherlight.Init();
});
}
}
};
return Lightbox;
});
```
Also set your main.js file to include this line:
```js
paths: {
...
plugin: '/user/plugins',
...
},
```
# Updating
As development for the Featherlight plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Featherlight is easy, and can be done through Grav's GPM system, as well as manually.
## GPM Update (Preferred)
The simplest way to update this plugin is via the [Grav Package Manager (GPM)](https://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:
bin/gpm update featherlight
This command will check your Grav install to see if your Featherlight plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.
## Manual Update
Manually updating Featherlight is pretty simple. Here is what you will need to do to get this done:
* Delete the `your/site/user/plugins/featherlight` directory.
* Download the new version of the Featherlight plugin from either [GitHub](https://github.com/getgrav/grav-plugin-featherlight) or [GetGrav.org](https://getgrav.org/downloads/plugins#extras).
* Unzip the zip file in `your/site/user/plugins` and rename the resulting folder to `featherlight`.
* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.
> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.