发版说明
本文提供声网 Fastboard SDK for Web 的发版说明。
1.0.0 版
该版本于 2024 年 12 月 12 日发布。
启用 v1.1.1 及以上版本的 appliance-plugin 插件后，可以使用 Fastboard UI 新增的激光铅笔工具 laserPen，使用方式详见appliance-plugin。
该版本将 @netless/window-manager 更新至 v1.0.0。
0.3.22 版
该版本于 2024 年 11 月 28 日发布。
自该版本起，Fastboard SDK 新增全打包文件 @netless/fastboard/full 和 @netless/fastboard-react/full，用于解决内外依赖冲突问题。使用全打包方式引用时，无需再安装 @netless/window-manager 和 white-web-sdk 等依赖。
使用全打包方式引用时，你需要在项目中移除 @netless/window-manager、white-web-sdk 和 jspdf 依赖。
- JavaScript 中引用
- React 中引用
// 全打包方式引用
import { createFastboard, createUI } from "@netless/fastboard/full";
// 分包方式引用
import { createFastboard, createUI } from "@netless/fastboard";
// 全打包方式引用
import { useFastboard, Fastboard } from "@netless/fastboard-react/full";
// 分包方式引用
import { useFastboard, Fastboard } from "@netless/fastboard-react";
更多全打包方式和分包方式引用的信息，详见 Fastboard 安装与使用。
该版本新增 appliance-plugin 插件，实现了一套高性能的白板绘制工具，且支持在多窗口模式下使用。安装 @netless/appliance-plugin 后，你可以通过 FastboardOptions.enableAppliancePlugin 和 managerConfig.supportAppliancePlugin 配置项启用该插件。详见appliance-plugin。
@netless/appliance-plugin为必需外部依赖，不包含在全打包文件中，需要单独安装。- 为确保笔迹正常显示，请在所有终端（Web、Android 和 iOS）上都开启
appliance-plugin插件。如果某个终端未开启，其他终端使用appliance-plugin绘制的笔迹将无法在该终端显示。 - 开启
appliance-plugin插件后，白板上的历史内容仍会显示，但无法对其进行操作或升级。为避免影响使用体验，建议在全新的白板上使用该插件。关闭插件后，使用该插件绘制的内容将会丢失。 - 浏览器需完整支持 Web API
OffscreenCanvas，才能获得最佳性能和完整的教具功能体验。
你可以参考以下示例代码启用 appliance-plugin 插件：
// 直接通过raw-loader引入
import fullWorkerString from '@netless/appliance-plugin/dist/fullWorker.js?raw';
import subWorkerString from '@netless/appliance-plugin/dist/subWorker.js?raw';
const fullWorkerBlob = new Blob([fullWorkerString], {type: 'text/javascript'});
const fullWorkerUrl = URL.createObjectURL(fullWorkerBlob);
const subWorkerBlob = new Blob([subWorkerString], {type: 'text/javascript'});
const subWorkerUrl = URL.createObjectURL(subWorkerBlob);
// CDN 引入, 需要部署到自己的CDN服务器上, 它必须遵守 同源策略 。
const subWorkerUrl = "https://cdn.jsdelivr.net/npm/@netless/appliance-plugin@latest/dist/subWorker.js";
const fullWorkerUrl = "https://cdn.jsdelivr.net/npm/@netless/appliance-plugin@latest/dist/fullWorker.js";
function App() {
const fastboard = useFastboard(() => ({
sdkConfig: {
...
},
joinRoom: {
...
},
// 开启 appliance-plugin 插件, 和windowManager 配置
managerConfig: {
supportAppliancePlugin: true
},
// 开启 appliance-plugin 插件
enableAppliancePlugin: {
cdn: {
fullWorkerUrl,
subWorkerUrl,
}
}
}));
....
}
ToolbarConfig 接口新增 colors 属性，用于设置 UI 组件的颜色。自该版本起，默认情况下，工具条 (toolbar) 和悬浮条 (floatbar) 的颜色保持一致，应用统一的颜色集合。你也可以通过 joinRoomParams.floatbarOptions.colors 或 ToolbarConfig.colors 分别设置两者的颜色集合。
0.3.16 版
该版本于 2024 年 9 月 14 日发布。
新增 canOperate 方法，用于获取房间是否处于可操作状态，即获取当前房间是否处于互动模式 (writable) 且房间连接状态为已连接 (connected)。
该版本进行了如下改进：
- 多窗口模式下，插入的小窗应用支持拖动窗口右上角以调整窗口大小。
- 支持在调用
destroy销毁状态后访问状态的值 (state.value)。 insertDocs方法支持传入带prefix字段的静态转换的响应包体。
该版本修复了如下问题：
- 使用
insertDocs插入静态转换后的文档无法返回appId。 - 当
FatboardUIConfig更新为{ toolbar: undefined }时出错。 - 监听部分状态（例如
camera.value）时返回的不是最新值。 - 房间连接状态 (
room.phase) 为未连接时，部分组件失效。
canOperate
0.3.10 版
该版本于 2024 年 2 月 4 日发布。
该版本为以下白板教具添加了新特性：
- 铅笔工具：新增
toggleDottedLine方法，用于切换铅笔工具的画线样式。 - 铅笔橡皮工具：新增
setPencilEraserSize方法，用于修改铅笔橡皮的大小。
该版本进行了如下改进：
insertImage方法新增参数crossOrigin，用于设置是否对插入的图片启用跨域资源共享 (CORS, Cross-Origin Resource Sharing) 。- 新增
jumpPage方法，用于跳转至指定白板页。相比之前修改FastboardApp的sceneIndex属性的方式更加便捷。
该版本修复了重新连接白板房间后偶现 FastobardApp.camera 控件显示的白板画布缩放比例无法随实际情况变化的问题。
toggleDottedLinesetPencilEraserSizeinsertImage新增参数crossOriginjumpPage
0.3.8 版
该版本于 2023 年 8 月 17 日发布。
新增 insertDocs [1/2] 方法，用于快速插入新版文档转换服务转换后的 PDF/PPTX 文档。
新增 dispatchDocsEvent 方法，用于向插入白板的 PDF/PPTX 文档发送事件，实现控制文档翻页、页面跳转和幻灯片动画播放。
该版本修复了使用旧版本打包器时偶现的打包失败问题。
0.3.6 版
该版本于 2022 年 10 月 28 日发布。
该版本在 FastboardOptions 接口中新增可选属性 netlessApps，用于注册 Fastboard 官方内置或由你自定义的 Fastboard 插件，详见注册和使用 app。
该版本新增了 createUI 和 createReplayUI 方法分别用于创建 Fastboard 内置的一套 UI 组件和回放模式的一套 UI 组件。
该版本新增了 removePage 方法用于删除指定白板页。
该版本进行了如下改进：
- 点击插件按钮后自动隐藏插件菜单。
- 向白板日志提交 Fastboard 信息。
- 优化 UI 在 React 下使用时的性能。
该版本修复了如下问题：
- 白板在某些设备上可能失焦。
- 用户自定义热键的 UI 显示错误。
0.3.2 版
该版本于 2022 年 4 月 29 日发布。
该版本替换了构建白板用户界面使用的框架。集成该版本的 Fastboard SDK，无需再添加 react 和 react-dom 依赖项。详见添加依赖项。
该版本在 mount 方法中新增 options 参数，用于配置白板用户界面。你可以通过该参数设置白板用户界面的主题、语言和每个组件的显示状态等。
同时，该版本还将调用 mount 方法后返回的 update 方法的 theme 和 language 变更为 props 参数。通过 props 参数可以更新白板用户界面的主题、语言和每个组件的显示状态等。
该版本在 FastboardApp 类中新增 setTextColor 和 setTextSize 方法，用于设置字体的颜色和大小，方便你自行开发文本编辑功能。
该版本新增 AppsInToolbar 类，提供管理工具条上插件按钮方法，具体如下：
该版本进行了如下改进：
- 优化了用户界面的样式。
- 当用户以只读模式加入白板房间时，SDK 自动隐藏用户界面上的所有组件，以避免用户点击却不生效。
0.2.8 版
该版本于 2022 年 3 月 7 日发布，是 Fastboard SDK 首个版本。
该版本直接实现了互动白板的核心基础功能，并提供默认的 UI。集成 Fastboard SDK 并调用 createFastboard 方法加入白板房间后，即可使用如下功能：
- 白板工具栏，包括铅笔、文本编辑、图形工具等所有白板基础编辑工具，并支持设置线条粗细、字体大小和颜色。
- 页面管理，包括新增页面和页面跳转。
- 视角管理，包括页面缩放和视角调整。
- 撤销、重做
同时，Fastboard SDK 还提供了如下 API，方便你自行开发这些功能并自定义 UI：
setAppliancesetStrokeWidthsetStrokeColormoveCameramoveCameraToContainundoredo
Fastboard SDK 集成了窗口管理器（Window Manager）和插件中心（Netless App），用于在白板应用中快速添加和使用插件，扩展白板的功能。该版本默认提供代码编辑器（Code Editor）、计时器（Countdown）、数学计算器（GeoGebra）插件，加入房间即可使用。此外，你还可以根据业务需求开发并添加自定义插件。
GeoGebra 数学计算器仅作为示例插件，如需商用，请联系 GeoGebra 获取许可。
Fastboard SDK 支持在白板中插入和展示多种形式的文件，例如，PNG、JPG 格式的图片，MP3、MP4 格式的音视频，以及 PPT、PPTX、DOC、DOCX、PDF 等格式的文档。具体实现步骤参考展示文件。