# @microsurveysai/react-native 中文文档

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

版本：0\.1\.3
npm 元数据更新时间：2026-11-01T20:10:51.580Z
中文译文更新时间：2026-11-01T21:15:56.350Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40microsurveysai/react-native
原文对照：https://npmcn.com/package/%40microsurveysai/react-native/?lang=original
项目主页：https://github.com/MicroSurveysAI/microsurveys-react-native
源码仓库：https://github.com/MicroSurveysAI/microsurveys-react-native

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

- 包体积（解压后）：606 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：react \>=18，react-native \>=0\.72，react-native-safe-area-context \>=4\.0\.0，@react-native-async-storage/async-storage \>=1\.17\.0
- 首次发布：2026-10-19T19:27:26.878Z
- 最新版本发布：2026-11-01T20:10:51.402Z
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

React Native SDK for MicroSurveys——原生应用内调查，由你已经跟踪的事件在设备上触发。

## 安装

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

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

## README

# MicroSurveys React Native SDK

针对React Native和Expo应用的应用内微调查，发布到npm `@microsurveysai/react-native`． 的React Native对应 [MicroSurveys iOS SDK](https://github.com/MicroSurveysAI/microsurveys-ios)的应用程序 [MicroSurveys](https://microsurveys.ai/)． 您在仪表板中发布的调查 评估 **设备内置** 针对您已经跟踪的事件，并以本地形式呈现 底页或对话框。与Expo（包括Expo Go）和bare React Native兼容，支持iOS和 Android。

```bash
npx expo install @microsurveysai/react-native @react-native-async-storage/async-storage react-native-safe-area-context
```

## 快速启动

```tsx
import { MicroSurveys, MicroSurveysProvider } from "@microsurveysai/react-native";

export const ms = new MicroSurveys({ apiKey: "ms_live_…" });

export default function App() {
  return (
    <MicroSurveysProvider instance={ms}>
      <RootNavigator />
    </MicroSurveysProvider>
  );
}
```

然后转发你的振幅事件：

```ts
import { add } from "@amplitude/analytics-react-native";

add(ms.amplitudePlugin()); // events + identity flow in; events pass through unmodified
```

或手动跟踪和识别：

```ts
ms.identify("user_123", { plan: "pro" });
ms.track("checkout_completed", { amount: 42 });
```

内部组件, `useMicroSurveys()` 返回相同的值 `track` / `identify`.

## 内联的调查

```tsx
import { MicroSurvey } from "@microsurveysai/react-native";

<MicroSurvey surveyId="svy_abc" onComplete={(result) => console.log(result)} />;
```

## 选项

| `new MicroSurveys({...})` | 默认的 |  |
| --- | --- | --- |
| `apiKey` | \- - - - - - | 您的项目API密钥。 |
| `apiBaseURL` | `https://console.microsurveys.ai` | 用于自托管部署。 |
| `refreshOnForeground` | `true` | 在应用程序前台，重试排队摄取和刷新陈旧的配置。 |
| `configTTLms` | 12小时 | 缓存的配置计算为新鲜的时间。 |
| `storage` | AsyncStorage | 要持久化到的同步存储（例如MMKV）。 |
| `appVersion` | \- - - - - - | 你的应用程序版本(例如： `"3.2.0"`)，与响应一起发送，以便可以比较不同版本的结果。有世博，通世博 `Application.nativeApplicationVersion` 从 `expo-application`. |

`<MicroSurveysProvider>` 也需要 `autoStart` (默认 `true`), `fontFamily` (一个字体你的应用程序 已注册，例如： `expo-font`;调查使用系统字体，否则)。

要预览没有后端的调查，请渲染 `<SurveyModal survey={…} theme={…} />` 直接。

完整的指南: [https://docs.microsurveys.ai/react-native-sdk](https://docs.microsurveys.ai/react-native-sdk)

## 示例应用程序

[`example/`](https://npmcn.com/package/%40microsurveysai/react-native/example) 是一个博览会应用程序，可以在没有后台的情况下呈现所有类型的问题：

```bash
cd example && npm install && npx expo start --ios
```

## 开发

```bash
npm install
npm run typecheck
npm test        # vitest
npm run build   # tsup → ESM + CJS + d.ts
```

> 发布版本发布到npm，并在这里标记，在 [释放](https://github.com/MicroSurveysAI/microsurveys-react-native/releases) 页面。这 仓库不接受拉取请求；发现bug或需要什么？打开一个问题。

## 许可证

麻省理工学院

## 常见问题

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

React Native SDK for MicroSurveys——原生应用内调查，由你已经跟踪的事件在设备上触发。

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

在项目目录运行 npm install @microsurveysai/react-native，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）、react-native（\>=0\.72）、react-native-safe-area-context（\>=4\.0\.0）、@react-native-async-storage/async-storage（\>=1\.17\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

### @microsurveysai/react-native 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

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

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

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

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