@getrollee/connect-react-sdk

中文文档
1.3.1发布于 2025/10/13ESM + CJS近 30 天下载 1.1万

A React SDK for Rollee Connect

原始使用文档
文档目录9 节
  1. Change Log
  2. v.1.3.1
  3. v.1.3.0
  4. v.1.3.0
  5. v.1.2.1
  6. v1.2.0
  7. v1.1.2
  8. v1.1.1
  9. v1.1.0

Installation

$ npm i @getrollee/connect-react-sdk

Change Log

v.1.3.1

  • React version update (19.2.0)

v.1.3.0

  • React version update

v.1.3.0

  • React version update

v.1.2.1

  • small fixes

v1.2.0

==Breaking changes - Important!==

  • adding customizationId parameter to configuration
  • removing setup parameter from configuration
  • removing token parameter from configuration

v1.1.2

  • onCompleted callback fix

v1.1.1

  • small fixes

v1.1.0

  • onLoginSuccess callback added

Usage

The RolleeConnect component is a view that you can integrate into your app's flow. The CONFIG and optional callback handlers are passed in as props.

import RolleeConnect from '@getrollee/connect-react-sdk';
.
.
.
<RolleeConnect config={CONFIG} onCompleted={onCompleted} />;

Configuration

To define a User Session on Rollee Connect, you must provide the mandatory parameters token and sessionToken.

The setup parameters are optional.

▫️ The minimal configuration for setting up RolleeConnect component:

const CONFIG = {
  sessionToken: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
};

The optional configuration for setting up RolleeConnect component:

const CONFIG = {
  sessionToken: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  production: false,
  customizationId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
};

// If you wish not to customize one of the parameters present in `setup`, you can just delete them and the SDK will use the respective default value.

Testing SDK in the Sandbox

To be able to test SDK in Sandbox mode, you should provide a setup parameter named production and set it to false.

setup: {
  production: false
}

Setup Parameters Descriptions

ParamDescription
sessionTokenString - defining user session on Rollee Connect application
productionBoolean - parameter for switching between sandbox and production env
customizationIdString - defining customization on Rollee Connect application

For more information about the setuping up your SDK, please visit our documentation.

版本与发布记录

@getrollee/connect-react-sdk 共发布 14 个版本,首次发布于 2022/04/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.3.1latest2025/10/131.1 年前
1.3.02024/11/202 年前
1.2.12024/01/172 年前
1.2.02024/01/172 年前
1.1.22023/11/063 年前
1.1.12023/06/263 年前

关于 @getrollee/connect-react-sdk 的常见问题

@getrollee/connect-react-sdk 是什么?

A React SDK for Rollee Connect

如何安装 @getrollee/connect-react-sdk?

在项目目录运行 npm install @getrollee/connect-react-sdk,或使用 pnpm add / yarn add / bun add。

@getrollee/connect-react-sdk 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/getrollee__connect-react-sdk 是否存在。

@getrollee/connect-react-sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@getrollee/connect-react-sdk 可以商用吗?

@getrollee/connect-react-sdk 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@getrollee/connect-react-sdk 的下载量有多少?

根据 npm 官方下载统计,@getrollee/connect-react-sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 11,149 次,日均约 372 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getrollee/connect-react-sdk 还在维护吗?

最新版本 1.3.1 发布于 2025/10/13(1.1 年前);至今共发布 14 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/04/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。