fork of shareon for my own website
 
 
 
Go to file
Nikita Karamov d6e160aa5c
Add usage instructions to README
2020-03-26 00:44:31 +01:00
.github Initial commit 2020-03-25 16:32:25 +01:00
docs Add usage instructions to README 2020-03-26 00:44:31 +01:00
rollup Rename shareon.css to shareon.min.css 2020-03-25 22:52:30 +01:00
src Add Facebook Messenger 2020-03-26 00:02:41 +01:00
.eslintignore Set up build and linting 2020-03-25 17:44:11 +01:00
.eslintrc.js Set up build and linting 2020-03-25 17:44:11 +01:00
.gitignore Add size-limit & eslint-ci 2020-03-25 22:09:35 +01:00
.travis.yml Set up build and linting 2020-03-25 17:44:11 +01:00
LICENSE Initial commit 2020-03-25 16:32:25 +01:00
README.md Add usage instructions to README 2020-03-26 00:44:31 +01:00
package.json v1.0.0-beta.3 2020-03-26 00:08:25 +01:00
tsconfig.json Set up build and linting 2020-03-25 17:44:11 +01:00
yarn.lock Add size-limit & eslint-ci 2020-03-25 22:09:35 +01:00

README.md

shareon

Postal Horn emoji

Lightweight, stylish and ethical share buttons.

  • Small. Dependency-free.
  • Stylish. Uses official vector logos and colors.
  • Ethical. No tracking code is being embedded.
shareon example

Observe the live demo here: os.karamoff.dev/shareon

Install

Include the link to shareon's JS and CSS in your website:

<link href="https://cdn.jsdelivr.net/npm/shareon@1/dist/shareon.min.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/shareon@1/dist/shareon.min.js" type="text/javascript"></script>

or install it via NPM use it in a JS file that you will bundle:

npm install shareon
# or
yarn add shareon
require('shareon');

Usage

Create a container with class shareon and populate it with elements, whose classes match the names of social networks:

<div class="shareon">
    <a class="facebook"></a>
    <a class="messenger"></a>
    <a class="pinterest"></a>
    <a class="telegram"></a>
    <a class="twitter"></a>
    <a class="whatsapp"></a>
</div>

By default the URL and the title of the page will be used in sharing dialogs. To change this, you can use the data-url and data-title attributes. Use them on the whole container or on the specific links:

<div class="shareon" data-url="https://example.com">
    <a class="facebook" data-title="Custom Facebook title"></a>
    <a class="twitter" data-title="Custom Twitter title"></a>
</div>

Apart from the URL and title, some networks support extra parameters:

  • add data-via to a Twitter button to mention a user
  • add data-text to a WhatsApp or Telegram button to add custom message text
  • add data-media to a Pinterest button to customize the pinned picture

Here are all the custom parameters in their glory:

<div class="shareon" data-url="https://example.com/custom-url">
    <a class="facebook" data-title="Custom Facebook title"></a>
    <a class="messenger" data-url="https://my-cool-website.com"></a>
    <a class="pinterest" data-media="https://picsum.photos/500">Pin</a>
    <a class="telegram" data-text="Check this out!"></a>
    <a class="twitter" data-via="MyNickname"></a>
    <a class="whatsapp">Send</a>
</div>