Skip to content

Wunsz/grav-plugin-deferred-instagram

Repository files navigation

Deferred Instagram Plugin

The Deferred Instagram Plugin is for Grav CMS. Makes an API call to Instagram after page was loaded and then dynamically loads the conent.

Installation

Installing the Deferred Instagram plugin can be done in one of two ways. The 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) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install deferred-instagram

This will install the Deferred Instagram plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/deferred-instagram.

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 deferred-instagram. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/deferred-instagram

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

IMPORTANT: This plugin requires following Instagram Grav plugin.

Admin Plugin

If you use the admin plugin, you can install directly through the admin plugin by browsing the Plugins tab and clicking on the Add button.

Configuration

Before configuring this plugin, you should copy the user/plugins/deferred-instagram/deferred-instagram.yaml to user/config/plugins/deferred-instagram.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true

Note that if you use the admin plugin, a file with your configuration, and named deferred-instagram.yaml will be saved in the user/config/plugins/ folder once the configuration is saved in the admin.

Usage

To use this plugin you simply need to include a function your template file such as:

{{ deferred_instagram_feed() }}

This will set the twig template from the Instagram plugin, but it will be fetched via ajax. See the Instagram plugin for reference.

Credits

Thanks to Igor Buyanov, creator of the original Instagram plugin: https://github.com/artifex404/grav-plugin-instagram/

About

Makes an API call to Instagram after page was loaded and then dynamically loads the conent.

Resources

License

Stars

Watchers

Forks

Packages

No packages published