1.1.0 • Published 7 years ago

korea-share-button v1.1.0

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

An Introduction

Korea Version of Share Button - A Simple, light, flexible, and good-looking share button. See it in action!

Korea SNS supported?

  1. KakaoStory (PC)
  2. KakaoTalk (Mobile)
  3. NaverLine (Mobile)
  4. NaverBand (Mobile)
  5. NaverBlog (PC)

Getting Started

  1. Download the latest script & stylesheet and include it on your page.
  2. Make a share-button element on your page
  3. In your javascript, call new ShareButton()
  4. Pass options to the share call if you want (details below)
  5. Profit!
<share-button></share-button>
new ShareButton({
  networks: {
    facebook: {
      app_id: "abc123"
    }
  }
});

Customization

Configuration Options

The share button is extremely flexible. As such we provide the ability to pass a wide array of options for additional configuration. All configuration options are available here: Configuration Options

Styles

Additionally, you're able to customize the look and feel of the button and animations though CSS. All CSS styles and how to modify them are available here: CSS Styles

Hooks

You are able to set before and after hooks when a user clicks a network. This allows you to dynamically change attributes for that button. For more information: click here

Public API

The share button also returns a simple API that can be used to control it should you need to. Example shown below:

var share = new ShareButton(); // Grabs all share-button elements on page

share.toggle(); // toggles the share button popup
share.open();   // open the share button popup
share.close();  // closes the share button popup
share.config;   // exposes the configurations listed above

Contributing and License