安装

使用 npm 安装

npm install @polyv/white-board-sdk -S

引入 WhiteBoardSDK

安装完成后，即可使用 import 创建白板。

import { WhiteBoard } from '@polyv/white-board-sdk';

const whiteBoard = new WhiteBoard('.container', {
  // config...
});

按需引入 WhiteBoardSDK 的功能

上面的代码会引入 WhiteBoardSDK 中所有的功能，包括所有的教具、图形、行为等，但是假如您的项目中并不需要使用到所有的功能，可以使用 WhiteBoardSDK 中提供的按需引入的方法来安装对应的功能，从而减少构建后的体积。

// 引入 @polyv/white-board-sdk 核心模块，该模块提供了 WhiteBoardSDK 的核心功能实现。
import { WhiteBoard } from '@polyv/white-board-sdk/core';
// 引入 appliance 教具模块的安装器
import {
  ArrowApplianceInstall,
  FreeLineApplianceInstall,
} from '@polyv/white-board-sdk/appliance';
// 引入 shape 图形模块的安装器
import {
  ArrowShapeInstall,
  FreeLineShapeInstall,
} from '@polyv/white-board-sdk/shape';

// 安装所需的功能
WhiteBoard.use([
  ArrowApplianceInstall,
  FreeLineApplianceInstall,
  ArrowShapeInstall,
  FreeLineShapeInstall,
]);

/**
 * 与全局引入一样创建白板实例。
 * 此时构建打包后，只会打包对应功能的代码。
 */
const whiteBoard = new WhiteBoard('.container', {
  // config...
});