newloong / weixin-share

An easier way to call Wechat share on a web page.

Weixin Share

• An easier way to call Wechat share on a web page.
• weixin-share has been renamed to @cycjimmy/weixin-share for scoped NPM package.

How to use

Install

# via npm
$ npm install @cycjimmy/weixin-share --save

# via yarn
$ yarn add @cycjimmy/weixin-share

Usage

import wxShare from '@cycjimmy/weixin-share';
# OR
const wxShare = require('@cycjimmy/weixin-share');

wxShare()
  .config([wechatJSSDKConfig])
  .setReadyCallBack([wechatConfigReadyCallBack])
  .setDefaultShare([defaultShare])
  .setShareSuccessCallBack([shareSuccessCallBack])
  .share([shareConfig]);

• Function:

  • config(): Set Wechat JS-SDK Config.
  • setReadyCallBack(): Set CallBack function on Wechat Config Ready.
  • setDefaultShare(): Set Default Share Config.
  • setShareSuccessCallBack(): Set CallBack function on success of Share. discard above Wechat 6.7.2 and JSSDK 1.4.0
  • share(): Run Main Task of Share. It returns Promise<any>. If using a chained call, please note the sequence.
  • backToDefault(): Back To Default Share Config.

• Params:

  • wechatJSSDKConfig: [Require][Object] Wechat JS-SDK Config.
    • debug: [Option][Boolean] Default false.
    • appId: [Require][String]
    • timestamp: [Require][Number | String]
    • nonceStr: [Require][String]
    • signature: [Require][String]
    • jsApiList: [Option][Array<String>] Default ['onMenuShareWeibo', 'updateAppMessageShareData', 'updateTimelineShareData']
  • wechatConfigReadyCallBack: [Option][Function] CallBack function on Wechat Config Ready.
  • defaultShare: [Option][Object] Default Share Config.
    • title: [Option][String] Set share title.
    • desc: [Option][String] Set share description.
    • link: [Option][String] Set share link URL.
    • imgUrl: [Option][String] Set URL of Share icon.
  • shareConfig: [Option][Object] Share Config.
    • See defaultShare Params.

• Wechat Official Wiki

Use in browser

<script src="weixin-share.umd.min.js"></script>
<script>
  wxShare()
    .config({
      appId: [appId],
      timestamp: [timestamp],
      nonceStr: [nonceStr],
      signature: [signature]
    })
    .share({
      title: [share title],
      desc: [share desc],
      link: [share link],
      imgUrl: [share imgUrl]
    });
</script>

CDN

To use via a CDN include this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/@cycjimmy/weixin-share@5/dist/weixin-share.umd.min.js"></script>