Skip to content

Latest commit

 

History

History
112 lines (97 loc) · 5.9 KB

README.md

File metadata and controls

112 lines (97 loc) · 5.9 KB
Raw

<share-menu>

Published on webcomponents.org GitHub release

Demo and API docs

A complete and simple to use share menu for Polymer 2 that uses Web Share API when possible, with a fallback to a nice share menu that tries to emulate the experience of the native one.

Note that in addition to the support to the Web Share API, your browser needs to be within a secure context to be able to use it. This components tries to automatically detect it, but it is not 100% reliable, so make sure you take the appropriate measures.

Features

  • Incredibly simple to use. Just set the title, text and url properties and call the share() method to make the magic happen.
  • Heavily customizable. It is designed to be customized as much as possible by using CSS custom properties and mixins. Check the Styling section to see what you can do.
  • Compatible with almost any browser. The Web Share API is still quite young, but the fallback menu should work on any of the major browsers, since it mostly uses window.open calls.

Installation

bower install --save Dabolus/share-menu

Usage

Basic usage

<share-menu id="shareMenu" title="Ohai!" text="Just a test" url="https://www.example.com/"></share-menu>

<button onclick="shareMenu.share()">Share!</button>

All the properties set

<share-menu
  title="Awesome!"
  text="More customized share menu"
  url="https://www.example.com/"
  via="Dabolus"
  dialog-title="Share now!"
  copy-success-text="Text copied to clipboard!"
  copy-failed-text="Oh no! Couldn't copy the text automatically :("
  facebook-app-id="<your Facebook App ID to use the Facebook UI share>"
  is-image="auto"
  hide-labels>
</share-menu>

As you can see in this last example, this component allows you to insert your own Facebook App ID to use the Facebook UI share. It is heavily recommended to use it if possible, since it offers a much better user experience. You can get one here.

Supported socials (in the fallback dialog)

Here you can see the list of the supported socials, as well as the limitations that each one gives:

  • Baidu - URL and title only
  • Blogger
  • Buffer - URL and title only
  • Copy to clipboard
  • Delicious - URL and title only
  • Digg - URL and title only
  • Douban - URL and title only
  • Email
  • Evernote - URL only
  • Facebook - URL only if not using a Facebook App with the facebook-app-id parameter
  • FlipBoard - URL and title only
  • Google+ - URL only
  • Instapaper
  • Line - URL only
  • LinkedIn
  • LiveJournal
  • Myspace
  • Odnoklassniki (OK.ru) - URL and title only
  • Pinterest - Will only be visible if the URL is an image. Look for the isImage parameter on the API docs for more info
  • Pocket - URL only
  • Print - Only prints the page at the given URL
  • QZone - URL only
  • Reddit - Shares an URL if there is no text provided, otherwise a text with the URL appended at the end will be shared.
  • RenRen - _Currently disabled because it does not seem to work
  • Skype - URL only
  • SMS
  • StumbleUpon - URL and title only
  • Telegram
  • Translate - Only translates the page at the given URL
  • Tumblr
  • Twitter
  • Viber
  • VKontakte - URL only
  • Weibo
  • WhatsApp
  • WordPress
  • Xing - URL only
  • Yahoo

The via parameter will only be used by Delicious, LinkedIn and Twitter.

Icons

The icons used by the component are a special iconset, so you can also use them everywhere in your app by importing social-icons.html located in this package.

Styling

The following custom properties and mixins are available for styling:

Custom property Description Default
--dialog-background-color The background color of the dialogs white
--dialog-text-color The text color of the dialogs black
--toast-background-color The background color of the "copied to clipboard" toast #323232
--toast-text-color The text color of the "copied to clipboard" toast #f1f1f1
--clipboard-fallback-url-color The text color of the fallback url color (when automatic copying to clipboard fails) #ff6d00
--share-dialog Mixin applied to the share dialog {}
--copy-dialog Mixin applied to the "copy to clipboard" fallback dialog {}
--dialog-title Mixin applied to the share dialog title {}
--social-icon Mixin applied to the social icons {}
--social-text Mixin applied to the text under the social icons (the social name) {}
--clipboard-fallback-url-header Mixin applied to the header of the "copy to clipboard" fallback dialog {}
--clipboard-fallback-url Mixin applied to the url of the "copy to clipboard" fallback dialog {}