Weixin Share
- An easier way to call Wechat share on a web page. Releases
This package has been deprecated
This package has been migrated to @cycjimmy/weixin-share for scoped NPM package. Please switch to @cycjimmy/weixin-share to stay up to date.
How to use
Install
# via npm $ npm install weixin-share --save # via yarn $ yarn add weixin-share
Usage
;# ORlet WxShare = ;
;
-
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.0share()
: Run Main Task of Share. It returnsPromise<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] Defaultfalse
.appId
: [Require][String]timestamp
: [Require][Number | String]nonceStr
: [Require][String]signature
: [Require][String]jsApiList
: [Option][Array<String>] Default['onMenuShareTimeline', 'onMenuShareAppMessage', 'onMenuShareQQ', 'onMenuShareQZone', '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.
- See
Use in browser
CDN
To use via a CDN include this in your HTML:
<script src="https://cdn.jsdelivr.net/npm/weixin-share@1/build/WxShare.min.js"></script>