开始
第一步
npm i paymonade-iframe
第二步
import { initPayIframe } from 'paymonade-iframe';
initPayIframe({
containerId: 'iframeId',
iframeUrl: 'your trade url'
});
<div>
<div id="iframeId" style="height: 900px; width: 100%"></div>
</div>
通用属性
maxHeight / maxWidth
default: infinity
type: integer
设置iFrame的最大高度/宽度。
minHeight / minWidth
default: 0
type: integer
设置iFrame的最小高度/宽度。
scrolling
default: false
type: boolean | 'omit'
启用iFrame中的滚动条。
- true applies
scrolling="yes" - false applies
scrolling="no" - 'omit' applies no
scrollingattribute to the iFrame
sizeHeight
default: true
type: boolean
根据内容高度调整iFrame的大小。
sizeWidth
default: false
type: boolean
根据内容宽度调整iFrame的大小。
Events
以下回调事件可以传递到父页上的iframe。
onClose
onClose: (iframeID) => boolean;
在iFrame通过'parentIFrame.close'或'iFrame.iFrameResizer.close'方法关闭之前调用。返回“false”将阻止iFrame关闭。
onClosed
onClosed: (iframeID) => undefined;
在iFrame通过'parentIFrame.close'或'iFrame.iFrameResizer.close'方法关闭之后调用。返回“false”将阻止iFrame关闭。
onInit
onInit: (iframe) => undefined;
在初始设置后调用。
onMessage
onMessage: ({iframe,message}) => undefined
<script>
initPayIframe({
onMessage: function (messageData) {
// Callback fn when message is received
alert(messageData.message)
},
onClosed: function (id) {
// Callback fn when iFrame is closed
},
})
</script>
URL的同步更新
要同步URL更新,需要解决两个问题:一个是何时触发更新动作,另一个是URL更新的规律,即维护父页面(系统A)的URL地址和iframe(系统B)的URL位置之间的映射关系。
为了保证URL的正常同步和更新功能,需要满足以下三种情况:
Case 1: 页面刷新,iframe可以加载正确的页面;
Case 2: 页面重定向,浏览器地址栏可以正确更新;
Case 3: 点击浏览器的前进或后退按钮将同步地址栏和iframe中的更改;
使用'parentIFrame.sendMessage()'方法接收从iFrame发布的消息。
onResized
onResized: ({ iframe, height, width, type }) => undefined;
iFrame调整大小后调用的函数。传递“messageData”对象,该对象包含触发iFrame调整大小的事件的iFrame、高度、宽度和类型。
IFrame Object Methods
iFrame初始化后,将绑定一个“iFrameResizer”对象。这有以下可用方法。
close()
从页面中删除iFrame。
moveToAnchor(anchor)
移动以在iFrame中定位。
resize()
Tell the iFrame to resize itself.
sendMessage(message, [targetOrigin])
将数据发送到包含页面,“消息”可以是任何可以序列化为JSON的数据类型。“targetOrigin”选项用于限制消息的发送位置,以防iFrame导航到另一个域。
initPayIframe({
sendMessage: function (messageData) {
// Callback fn when message is received
alert(messageData.message)
},
onClosed: function (id) {
// Callback fn when iFrame is closed
},
})