@starcier / collab-core

Starcier协作层的“无头”部分：注释和工作流存储、API 客户端及其类型。这里没有渲染任何东西或知道一个设计系统。

大多数构建器不直接使用这个包。 @starcier/builder-shell 为你装上它， 和 @starcier/collab-ui 在上面绘制注释和游览。只能自己去拿 当你的应用保持自己的外壳。

安装

npm install @starcier/collab-core@next

直到 1.0.0 已发布，版本为预发布(1.0.0-next.N)：总是安装 @next． 没有它，npm会安装第一个预发布版，而不是最新的。需要React 18或19。

使用

包装应用程序中使用注释或工作流的部分：

import { CollabProvider } from '@starcier/collab-core';

<CollabProvider
  apiBaseUrl={API_BASE_URL}       // the API origin, without /v1
  getToken={getAccessToken}       // null while nobody is signed in
  tenant={TENANT_SLUG}            // your builder's tenant slug
>
  {children}
</CollabProvider>

离开 apiBaseUrl 不设定，一切都背道而驰 localStorage，没有后端。保持 tenant 即使这样设置：它使该构造器的本地数据与同一构造器上的其他构造器分开 来源。作为 workflowSeeds 被复制到每个浏览器一次；后来编辑为a 代码中的种子只能在new下到达浏览器 id.

在启动时，提供者询问API是否仍然支持此版本。如果太旧， Comments和Tours会关闭，并显示一条消息，命名您需要的版本和升级 命令;应用程序的其余部分继续工作。

许可证

麻省理工学院