Skip to main content

RollCode SDK API 文档

简介​

RollCode SDK 是一个用于构建和管理自定义页面区域的 JavaScript SDK。它提供了丰富的接口用于页面渲染、组件管理和环境控制。

API 参考​

配置项 (Config)​

属性类型必填说明
regionsRegion[]是自定义区域
storageMediaStorageConfig是媒体存储配置

存储配置​

创建rollcode实例时，需要的storage配置，需前往项目配置自行查看

项目配置

:::

Method​

getRollCodeEnv()​

获取当前运行环境

async getRollCodeEnv(): Promise<'RollCode'|'NONE'>

render()​

渲染页面内容。

async render(): Promise<void>

destroy()​

销毁实例，清理资源。

destroy(): void

类型定义​

Region​

interface Region {
  label: string;           // 区域标签
  id: string; // 区域ID
  el?: HTMLElement | string; // ID对应的Dom元素
}

最佳实践​

1. 错误处理​

try {
  await rollcode.render();
} catch (error) {
  console.error('渲染失败:', error);
}

2. 资源清理​

// 在组件销毁时调用
rollcode.destroy();

获取RollCode编辑配置​

文档编写中..