File: README — Documentation for share

Small sharing buttons helpers lib.

Note : Templates markup is written with Twitter Bootstrap v3 in mind and the javascript for the link_share_button helper uses Bootsrap's collapse plugin. You can override the plugin's view markup for every helper and delete the [data-link-button] attribute for the link_share_button helper to avoid the associated javascript to run.

Installation

Add to your Gemfile and bundle install :

gem 'share_buttons'

Use the included generator to generate the initializer file and the customizable views :

rails generate share_buttons:install

At last, include the javascript file in your application.js with :

//= require share_buttons

Configuration

For Facebook sharing, you need to set the FACEBOOK_APP_ID environment variable or add your Facebook App Id to the generated initializer configuration file at config/initializers/share_buttons.rb :

ShareButtons.configure do |config|
  config.facebook.app_id = 'YOUR_APP_ID'
end

Usage

In your views, use any of the included helpers :

<%= facebook_share_button(resource_url(resource), title: resource.title) %>
<%= twitter_share_button(resource_url(resource), title: resource.title) %>
<%= google_plus_share_button(resource_url(resource), title: resource.title) %>
<%= pinterest_share_button(resource_url(resource), title: resource.title, image_url: resource.image.url) %>
<%= email_share_button(resource_url(resource), title: resource.title) %>
<%= link_share_button(resource_url(resource), title: resource.title) %>

And customize the generated views to your needs in app/views/share_buttons/_<provider>.html.haml

Note : Do not forget to use URL helpers and not Path helpers since the final URL is to be shared on other websites.

Facebook

Facebook's redirect_uri parameter will be set to request.original_url by default but you can pass a custom URL as follow

<%= facebook_share_button(resource_path(resource), title: resource.title, redirect_uri: a_custom_url) %>

Useful if you want to handle when user cancelled dialog (e.g. close popup) or successfully shared on his wall (e.g. track sharing hits)

Initializing plugins manually (async modals & co)

Sometimes you need to manually initialize the javascript plugins, like when the buttons where added to the page after the actual page loading, in a modal or in some other way.

All you need to do, is find the newly loaded container, and initialize the .shareButtons() plugin on it. This way, all the contained share buttons will be initialized.

// Let's imagine you're loading a modal through ajax
$.get('/lodal/modal').then(function(response) {
  $response = $(response);
  $response.appendTo('body').modal();
  // Now that you have the jQuery object containing the share buttons,
  // just initialize the plugin on it
  $response.shareButtons();
})

Licence