# @getcobrowse/react-native 中文文档

规范地址：https://npmcn.com/package/%40getcobrowse/react-native/

版本：1\.0\.0
npm 元数据更新时间：2026-10-19T18:30:01.863Z
中文译文更新时间：2026-11-16T05:56:02.654Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40getcobrowse/react-native
原文对照：https://npmcn.com/package/%40getcobrowse/react-native/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：261 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=18\.0\.0，react-native \>=0\.72\.0，react-native-svg \>=13\.0\.0，@daily-co/react-native-webrtc ^124\.0\.6-daily\.1，@daily-co/react-native-daily-js ^0\.84\.0
- 首次发布：2026-03-14T21:30:24.980Z
- 最新版本发布：2026-10-19T18:30:01.544Z
- 近 30 天下载量：4619（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

共享 SDK 的 Cobrowse 屏幕用于本地反应

## 安装

```sh
npm install @getcobrowse/react-native
```

也可以使用：`pnpm add @getcobrowse/react-native`、`yarn add @getcobrowse/react-native`、`bun add @getcobrowse/react-native`

## README

# @ getcobrowse/ react- native (英语)

反应原生SDK用于Cobrowse屏幕共享. 启用代理可以实时查看客户的移动屏幕,并带有说明,光标和亮点.

使用本地屏幕捕获(ReplayKit on iOS,MediaProjection on Android)通过Daily.js.

## 安装

```bash
# Install the SDK
npm install @getcobrowse/react-native

# Install peer dependencies
npm install @daily-co/react-native-daily-js @daily-co/react-native-webrtc react-native-svg
```

### iOS 设置( Expo)

将配置插件添加到您的 `app.json` 或者说 `app.config.js`数字 :

```json
{
  "expo": {
    "plugins": [
      ["@getcobrowse/react-native/plugin/withCobrowseBroadcast", {
        "appGroup": "group.com.yourcompany.yourapp.cobrowse"
      }]
    ]
  }
}
```

然后重建:

```bash
npx expo prebuild --clean
npx expo run:ios --device
```

> **重要内容:** 屏幕共享需要 **真设备** ——在iOS模拟器中不起作用. 您也需要开发, 而不是 Expo Go .

### iOS 设置( Bare React Introduction)

iOS 屏幕共享需要一个 **广播上传扩展**. Daily的SDK处理所有的IPC和帧编码——你只需要创建目标并把它接上.

**1\. 建立扩展目标:**

Xcode: File → New → 目标 → 广播上传扩展. 说吧 `CobrowseBroadcast`。取消检查“插入 UI 扩展”.

**2\. 替换 `SampleHandler.swift`数字 :**

替换生成 `SampleHandler.swift` 改为:

```swift
import ReactNativeDailyJSScreenShareExtension

public class SampleHandler: DailyRPHandler {
  override init() {
    super.init(appGroupIdentifier: "group.com.yourcompany.yourapp.cobrowse")
  }
}
```

**3\. 配置 App 组:**

Xcode 中,启用“ App Groups” 功能,用于 **两者** 您的主要应用目标 `CobrowseBroadcast` 扩展目标。 将相同的组标识符添加到两者中 .

**4\. 在Info.plist中添加:**

在你的主要应用程序 `Info.plist`数字 :

```xml
<key>RTCAppGroupIdentifier</key>
<string>group.com.yourcompany.yourapp.cobrowse</string>
<key>DailyScreenCaptureExtensionBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER).CobrowseBroadcast</string>
```

**5\. 安装吊舱并重建:**

```bash
cd ios && pod install && cd ..
```

> **重要内容:** 屏幕共享需要 **真设备** ——在iOS模拟器中不起作用.

### Android 设置

添加为 `AndroidManifest.xml`数字 :

```xml
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
```

在您的列表中注册前景服务 :

```xml
<service
  android:name="com.daily.reactlibrary.DailyOngoingMeetingService"
  android:foregroundServiceType="mediaProjection" />
```

## 使用量

### 基本设置(2行)

包装您的应用程序 `CobrowseProvider`数字 :

```tsx
import { CobrowseProvider } from '@getcobrowse/react-native'

export default function App() {
  return (
    <CobrowseProvider
      serverUrl="https://cobrowse.owner.sh"
      metadata={{ email: user.email, name: user.name }}
    >
      <YourApp />
    </CobrowseProvider>
  )
}
```

就是这样。 SDK会:

-   Corowse 仪表板上的注册存在
-   当代理请求屏幕共享时显示模式
-   通过 ReplayKit/ MediaProjection 处理本地屏幕捕获
-   显示代理说明( 曲线、 突出显示、 指针) 为覆盖

### 跟踪当前屏幕

过 `screenName` 显示用户在仪表板上的屏幕:

```tsx
<CobrowseProvider
  serverUrl="https://cobrowse.owner.sh"
  metadata={{ email: user.email }}
  screenName={currentRouteName}
>
```

### 用钩子

访问浏览状态和任何组件的控制 :

```tsx
import { useCobrowse } from '@getcobrowse/react-native'

function SupportButton() {
  const { state, agentName, stop } = useCobrowse()

  if (state === 'sharing') {
    return (
      <Button onPress={stop}>
        Stop sharing with {agentName}
      </Button>
    )
  }

  return null
}
```

### 自动接收( 窗口模式)

跳过权限模式和自动接受共享请求 :

```tsx
<CobrowseProvider
  serverUrl="https://cobrowse.owner.sh"
  metadata={{ deviceId: 'kiosk-001' }}
  autoAccept
>
```

### 浮动共享指标

使用内置 `SharingIndicator` 组件 :

```tsx
import { SharingIndicator } from '@getcobrowse/react-native'

function MyScreen() {
  return (
    <View>
      {/* Your content */}
      <View style={{ position: 'absolute', bottom: 40, alignSelf: 'center' }}>
        <SharingIndicator />
      </View>
    </View>
  )
}
```

### 自定义共享请求 UI

禁用内置模式并处理自己的请求 :

```tsx
import { CobrowseProvider, useCobrowse } from '@getcobrowse/react-native'

function App() {
  return (
    <CobrowseProvider
      serverUrl="https://cobrowse.owner.sh"
      metadata={{ email: user.email }}
      onShareRequest={(agentName) => {
        // Custom notification, bottom sheet, etc.
      }}
      autoAccept={false}
    >
      <CustomShareUI />
    </CobrowseProvider>
  )
}

function CustomShareUI() {
  const { state, agentName, acceptShare, declineShare } = useCobrowse()

  if (state !== 'share_requested') return null

  return (
    <BottomSheet>
      <Text>{agentName} wants to view your screen</Text>
      <Button onPress={acceptShare}>Allow</Button>
      <Button onPress={declineShare}>Decline</Button>
    </BottomSheet>
  )
}
```

### 回电

```tsx
<CobrowseProvider
  serverUrl="https://cobrowse.owner.sh"
  metadata={{ email: user.email }}
  onStateChange={(state) => analytics.track('cobrowse_state', { state })}
  onShareRequest={(agentName) => console.log(`${agentName} wants to share`)}
  onAnnotation={(event) => {
    // event.type: 'cursor' | 'highlight' | 'pointer' | 'clear' | 'cursor-hide'
  }}
>
```

## API 参考

### `<CobrowseProvider>`

| Prop | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `serverUrl` | `string` | 对 | 浏览服务器 URL |
| `metadata` | `Record<string, unknown>` | 没有 | 用户识别元数据 |
| `screenName` | `string` | 没有 | 当前仪表板的屏幕名称 |
| `autoAccept` | `boolean` | 没有 | 自动接受共享请求 |
| `onShareRequest` | `(agentName: string) => void` | 没有 | 代理请求共享时调用 |
| `onStateChange` | `(state: CobrowseState) => void` | 没有 | 调用国家过渡 |
| `onAnnotation` | `(event: AnnotationEvent) => void` | 没有 | 收到说明后调用 |

### `useCobrowse()`

回返a `CobrowseHandle`数字 :

| 财产 | 类型 | 说明 |
| --- | --- | --- |
| `state` | `CobrowseState` | 当前 SDK 状态 |
| `agentName` | `string | null` | 请求/查看代理人姓名 |
| `acceptShare` | `() => void` | 接受待决共享请求 |
| `declineShare` | `() => void` | 拒绝待处理的共享请求 |
| `stop` | `() => Promise<void>` | 停止活动屏幕共享 |
| `setMetadata` | `(metadata) => void` | 更新用户元数据 |
| `setScreenName` | `(name) => void` | 更新当前屏幕名称 |
| `annotations` | `Annotation[]` | 当前突出显示说明 |
| `pointerAnimations` | `PointerAnimation[]` | 当前指针波纹 |
| `cursor` | `CursorPosition` | 代理光标位置 |

### `CobrowseState`

`'idle' | 'tracking' | 'share_requested' | 'connecting' | 'sharing' | 'stopping'`

## 常见问题

### @getcobrowse/react-native 是什么？

共享 SDK 的 Cobrowse 屏幕用于本地反应

### 如何安装 @getcobrowse/react-native？

在项目目录运行 npm install @getcobrowse/react-native，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18\.0\.0）、react-native（\>=0\.72\.0）、react-native-svg（\>=13\.0\.0）、@daily-co/react-native-webrtc（^124\.0\.6-daily\.1）、@daily-co/react-native-daily-js（^0\.84\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @getcobrowse/react-native 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @getcobrowse/react-native 支持 ESM 还是 CommonJS？

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

### @getcobrowse/react-native 可以商用吗？

@getcobrowse/react-native 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @getcobrowse/react-native 的下载量有多少？

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

### @getcobrowse/react-native 还在维护吗？

最新版本 1\.0\.0 发布于 2026/10/20（27 天前）；至今共发布 16 个版本，其中过去 12 个月发布了 16 个；首次发布于 2026/03/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

