Permalink
Fetching contributors…
Cannot retrieve contributors at this time
152 lines (101 sloc) 4.75 KB

Grav Facebook Plugin

Facebook is a simple [Grav][grav] Plugin that includes your Facebook page content to your Grav website. Plugin can be used to get any public Facebook page content.

Posts example

Events example

Album example

Installation

Installing the Facebook plugin can be done in one of two ways. Using 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 facebook

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

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

You should now have all the plugin files under

/your/site/grav/user/plugins/facebook

Configuration

You need to provide few configurations in order for the feed show up. In your Grav Administration panel, go to Plugins > Facebook to view the plugin configuration page.

Enter the Facebook page_id which feed you want to show, and your Facebook API application_id and application_secret.

For more information how to get application set up, see the Facebook Developers documentation.

Customization

To customize how the your feed looks like, you might want to customize the generated markup. To do that, copy the template file facebook.html.twig to your templates/partials folder of your theme. For example:

/your/site/grav/user/themes/custom-theme/templates/partials/facebook.html.twig

It will now override the default markup of the feed. You can tweak it however you like.

Config Defaults

If you need to override some plugin default values, the best practise is to copy the facebook.yaml file into your users/config/plugins/ folder (create it if it doesn't exist), and then modify there. This will override the default settings.

Facebook page_id can be found with service like Find your Facebook ID.

Getting Facebook Posts

You simply need to include a function your template file such as:

{{ facebook_posts() }}

This will be converted into your Facebook posts as follows:

<div id='facebook-posts'>
{{ sectionTitle }}
  <div class='facebook-post'>
    <a href='{{ post.link }}' title='Facebook post'>
    <i class="fa fa-envelope post-icon" aria-hidden='true'></i><h4 class='media-heading'>{{ post.time }}</h4>
    <p>{{ post.message }}</p>
    {{ post.image }}
    </a>
  </div>
  ...
</div>

Filtering by tags

You can filter Facebook posts by tags function parameter or with config parameter Tag filter.

{{ facebook_posts('#MySpecialTag') }}

Getting Facebook Events

You simply need to include a function your template file such as:

{{ facebook_events() }}

This will be converted into your Facebook events as follows:

<div id='facebook-events'>
{{ sectionTitle }}
<table>
  <tr class='facebook-event'>
    <td class='start-date'>
      <span class='month'>{{ event.start_time.monthName }}</span>
      <span class='day'>{{ event.start_time.day }}</span>
    </td>
    <td class='details'>
      <span class='name'>{{ event.name }}</span><span class='location'>{{ event.place }}</span>
      <span class='period'>{{ event.period }}</span>
    </td>
  </tr>
  ...
</table>
</div>

Getting Facebook Album

You simply need to include a function your template file such as:

{{ facebook_album() }}

In the above 'album.name' is set at plugin configuration. Or you can give album name as function parameter like this:

{{ facebook_album('My Greatest Album') }}

This will be converted into your Facebook album as follows:

<div id='facebook-gallery'>
<h5>Album: {{ album.name }}</h5>
<div id='facebook-gallery-photos'>
    <img src="{{ photo.source }}" width=300 height=200/>
    ...
</div>
</div>

The Unitegallery jQuery plugin

Unite gallery can be used to display album photos and its theme can be set from the plugin configuration.