share-url/index.js

Generates social sharing url strings

/**
 * share-url v1.2.0
 * @link https://github.com/noeldelgado/share-url
 * @license MIT
 */
(function(root, factory) {
  if (typeof exports === 'object') module.exports = factory(root);
  else root.ShareUrl = factory(root);
}(this, function factory(root) {
  var ENDPOINTS = {
    facebook    : 'https://www.facebook.com/sharer/sharer.php?',
    twitter     : 'https://twitter.com/share?',
    pinterest   : 'https://pinterest.com/pin/create/button/?',
    reddit      : 'http://www.reddit.com/submit?',
    linkedin    : 'https://linkedin.com/sharing/share-offsite/?',
    whatsapp    : 'https://api.whatsapp.com/send?',
    telegram    : 'https://t.me/share/url?',
  };

  return {
    VERSION     : '1.2.0',
    facebook    : facebook,
    twitter     : twitter,
    pinterest   : pinterest,
    reddit      : reddit,
    linkedin    : linkedin,
    whatsapp    : whatsapp,
    telegram    : telegram,
    email       : email,
  };

  function _generateUrlParams(data) {
    return Object.keys(data || {}).map(function(propertyName) {
      return propertyName + '=' + encodeURIComponent(data[propertyName]);
    }).join('&');
  }

  /* Compose the share on facebook url string.
   * @argument data [Object] <required>
   * @argument data.u [String] <required>
   * @return url
   */
  function facebook(data) {
    return ENDPOINTS.facebook + _generateUrlParams(data);
  }

  /* Compose the share on whatsapp url string
   * @argument data [Object] <required>
   * @argument data.text [String] <required>
   * @return url
   */
  function whatsapp(data) {
    return ENDPOINTS.whatsapp + _generateUrlParams(data);
  }

  /* Compose the share on telegram url string
   * @argument data [Object] <required>
   * @argument data.url [String] <required>
   * @argument data.text [String] <optional>
   * @return url
   */
  function telegram(data) {
    return ENDPOINTS.telegram + _generateUrlParams(data);
  }

  /* Compose the share on twitter url string.
   * @argument data [Object] <required>
   * @argument data.text [String] <optional> Pre-populated text highlighted in the Tweet composer.
   * @argument data.in_reply_to [String] <optional> Status ID string of a parent Tweet such as a Tweet from your account (if applicable).
   * @argument data.url [String] <optional> URL included with the Tweet.
   * @argument data.hashtags [String] <optional> A comma-separated list of hashtags to be appended to default Tweet text.
   * @argument data.via [String] <optional> Attribute the source of a Tweet to a Twitter username.
   * @argument data.related [String] <optional> A comma-separated list of accounts related to the content of the shared URI.
   * @info https://dev.twitter.com/web/tweet-button/parameters
   * @return url
   */
  function twitter(data) {
    return ENDPOINTS.twitter + _generateUrlParams(data);
  }

  /* Compose the share on pinterest url string.
   * @argument data [Object] <required>
   * @argument data.url <required>
   * @argument data.media <required>
   * @argument data.description <required>
   * @info https://developers.pinterest.com/pin_it/
   * @return url
   */
  function pinterest(data) {
    return ENDPOINTS.pinterest + _generateUrlParams(data);
  }

  /* Compose the submit to reddit url string.
   * @argument data [Object] <required>
   * @argument data.url <required>
   * @argument data.title <optional>
   * @argument data.text <optional>
   * @info http://www.reddit.com/buttons/
   * @return url
   */
  function reddit(data) {
    return ENDPOINTS.reddit + _generateUrlParams(data);
  }

  /* Compose the share article on linkedin url string.
   * @argument data [Object] <required>
   * @argument data.url [String, 1024] <required> The url-encoded URL of the page that you wish to share.
   * @info https://developer.linkedin.com/docs/share-on-linkedin
   * @return url
   */
  function linkedin(data) {
    return ENDPOINTS.linkedin + _generateUrlParams(data);
  }

  /* Compose the send email url string.
   * @argument data [Object] <required>
   * @argument to [String] <required>
   * @argument subject [String] <optional>
   * @argument cc [String] <optional>
   * @argument bcc [String] <optional>
   * @argument body [String] <optional>
   * @info https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Email_links
   * @return url
   */
  function email(data) {
    var to = data.to;
    delete data.to;
    var params = _generateUrlParams(data);
    return 'mailto:' + (params.length ? (to + '?' + params) : to);
  }
}));