README

IframeBridge

本项目主要用于桥接白板的事件和属性到 iframe, 管理 iframe 的插入, 以及对白板的视角变化的跟随

注意, iframe 只有在教具为 选择工具 时候才能进行交互

安装

# npm
npm install @netless/iframe-bridge

# yarn
yarn add @netless/iframe-bridge

生命周期

IframeBridge 在监听到 iframe 的 load 事件时, 会发送一个 Init 事件到 iframe 并附带当前的 attributes 和 room 的 state

{
    kind: "Init",
    payload: {
        attributes: object,  // 当前 bridge 的 attributes
        roomState: object, // 当前白板的 state
        currentPage: number, //当前页数
        observerId: number, // 当前白板的 observerId
    }
}

如果 iframe 中没有接收到 Init 事件, 则可以手动发送一个 SDKCreate 事件到 IframeBridge

IframeBridge 会回复一个 Init 事件到 iframe 中

事件回放

当 iframe 自己准备完毕时可以发送一个 Ready 事件到 IframeBridge

IframeBridge 会把最后一个接收的自定义事件发送到 iframe 中

example

import {WhiteWebSdk} from "white-web-sdk"
import {IframeBridge, IframeWrapper} from "@netless/iframe-bridge"

const sdk = new WhiteWebSdk({
  // 其他参数
  invisiblePlugins: [IframeBridge],
  wrappedComponents: [IframeWrapper],
})

const room = await sdk.joinRoom()

let bridge;

bridge = room.getInvisiblePlugin(IframeBridge.kind) // bridge 插入一次后续会自动插入，所以需要先 get 防止重复插入

if (!bridge) {
    bridge = await IframeBridge.insert({
        room: room, // room 实例
        url: "example.com", // iframe 的地址
        width: 1280, // 课件的宽, 单位 px
        height: 720, // 课件的高, 单位 px
        displaySceneDir: "/example", // 自定义 h5 课件绑定的 scene 目录，切换到其他目录，课件会自动隐藏，注意，此目录需要用户在白板中自行创建,
        useSelector: false, // optional 此选项为可选，默认 false，开启会允许 selector 教具操作课件
    })
}

`attributes`

attributes 是会在所有插件中同步的属性, 类似于白板中的 globalState 概念, 但是只是同步在所有的插件中

bridge.attributes

`setAttributes`

修改 attributes, 并且会触发事件传递 attributes 到 iframe 中

readOnly 模式下不可用

bridge.setAttributes({ name: "bridge" })

`setIframeSize`

bridge.setIframeSize({ width: 1200, height: 700 }) // 修改 iframe 的宽高

监听 `bridge` 的事件

监听 iframe load 事件

import { DomEvents } from "@netless/iframe-bridge"

IframeBridge.emitter.on(DomEvents.IframeLoad, (event) => {
    // code
})

`destroy`

销毁插件

bridge.destroy()

在特定 `scene` 中使用 `H5` 课件

const dir = "/example" // h5 课件在白板中的目录名称，可以自定义为任意名称，注意不要跟已有目录重复
const scenes = [{name: "第一页"}, { name: "第二页" }] // h5 课件有多少页可以创建多少个, 但并不是严格对应
room.putScenes(dir, scenes)

room.setScenePath("/example/第一页") // 设置为课件目录的第一页

翻页可以使用 sdk 封装的翻页，也可以自己调用白板的翻页参考: 白板翻页

// 白板翻页
room.setSceneIndex(room.state.sceneState.index - 1); // 上一页
room.setSceneIndex(room.state.sceneState.index + 1) // 下一页

切换课件

bridge.setAttributes({ url: "https://xxxx.com" })

iframe 铺满屏幕

bridge.scaleIframeToFit()

在 `iframe` 中直接设置页数

IframeBridge 会监听来自 iframe 的事件并进行处理

并且只接受这种格式的数据

{
    kind: "event name",
    payload: data
}

在 iframe 中要直接设置白板到页数则需要 postMessage 到 IframeBridge

parent.postMessage({
    kind: "SetPage",
    payload: 10 // 根据 h5 课件的页数自行设置
}, "*") // 如果 iframe 跟父 window 不同源可能有跨域问题, 这里为了方便使用了 "*"

切换至指定页数

parent.postMessage({
    kind: "PageTo",
    payload: 2 // 切换至第二页
}, "*")

从 iframe 中发送并接收自定义事件

一共有三个步骤

发送自定义事件

parent.postMessage({
    kind: "DispatchMagixEvent",
    payload: {
        event: "clickA", // 要发送到事件名称
        payload: { data: 1 } // 事件内容
    }
}, "*")

注册对事件的监听

parent.postMessage({
    kind: "RegisterMagixEvent",
    payload: "clickA", // 注册对要接收事件的监听，同一个事件只会监听一次
}, "*")

接收事件

iframe 会收到一个 ReciveMagixEvent 的事件

{
    kind: "ReciveMagixEvent",
    payload: {
        event: "clickA",
        payload: { data: 1 }
    }
}

监听来自白板的翻页事件

白板切换 scene 会触发一个 RoomStateChanged 事件然后把 state 发送到 iframe 中

{
  kind: "RoomStateChanged",
  payload: { sceneState: { index: 0 } } // index 就是白板页数的 index, 从 0 开始
}

插件事件

事件名	解释
Init	在 `iframe` `load`事件完成时发送 `init` 事件
AttributesUpdate	插件的 `attributes` 更新时触发
SetAttributes	监听来自于 `iframe` 的 `postMessage` 信息, 并设置来自 `SetAttributes` 事件的 `attributes`
RegisterMagixEvent	注册白板的自定义事件
RemoveMagixEvent	移除白板的自定义事件
RemoveAllMagixEvent	移除所有白板的自定义事件
DispatchMagixEvent	发送白板自定义事件
ReciveMagixEvent	接收到自定义事件
OnCreate	插件创建时发送事件
SetPage	设置白板的页数
GetAttributes	接收到此事件会发送一个同名事件到 `iframe` 中并带上当前的 `attributes`
NextPage	切换白板到下一页
PrevPage	切换白板到上一页
PageTo	切换至指定页数
RoomStateChanged	白板状态改变事件

Dom 事件

事件	解释
WrapperDidMount	`iframe` 的 `wrapper` 组件 `didMount` 时触发
IframeLoad	`iframe` 的 `load` 事件触发

Usage no npm install needed!