1.0.3 • Published 5 years ago

coffeekraken-s-share-component v1.0.3

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Coffeekraken s-share-component

Easily create some share buttons to target facebook, twitter, linkedin, google+, etc...

View demo

Features

  • Easily share your page
  • Full control over the display.
  • Supported networks: - twitter - facebook - linkedin - googleplus - email - whatsapp - telegram - viber - pinterest - tumblr - hackernews - reddit - vk - buffer - xing - line - instapaper - pocket - digg - stumbleupon - flipboard - weibo - renren - myspace - blogger - baidu - okru

Table of content

  1. Demo
  2. Install
  3. Get Started
  4. Javascript API
  5. Sugar Web Components Documentation
  6. Browsers support
  7. Contribute
  8. Who are Coffeekraken?
  9. Licence

Install

npm install coffeekraken-s-share-component --save

## Get Started

First, import the component into your javascript file like so:

import SShareComponent from 'coffeekraken-s-share-component'

Then simply use it inside your html like so:

<a is="s-share" network="facebook" class="btn">
	Share on Facebook
</a>
<a is="s-share" network="twitter" title="Override the page title for sharing...">
	Share on Twitter
</a>

If you need some styling to start with, you can generate it like so:

@import 'node_modules/coffeekraken-s-share-component/index';
// only a base bare styling
@include s-select-classes-bare();
// ...and optionally the visual styles
@include s-select-classes-style(
	$colors : default primary secondary
);
// ...or generate directly the bare and style classes
@include s-select-classes(
	$colors : default primary secondary
);

## Browsers support

IE / EdgeFirefoxChromeSafari
IE11+last 2 versionslast 2 versionslast 2 versions

As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

## Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...