MicroSurveys React Native SDK
针对React Native和Expo应用的应用内微调查,发布到npm
@microsurveysai/react-native. 的React Native对应
MicroSurveys iOS SDK的应用程序
MicroSurveys. 您在仪表板中发布的调查
评估 设备内置 针对您已经跟踪的事件,并以本地形式呈现
底页或对话框。与Expo(包括Expo Go)和bare React Native兼容,支持iOS和
Android。
npx expo install @microsurveysai/react-native @react-native-async-storage/async-storage react-native-safe-area-context
快速启动
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>
);
}
然后转发你的振幅事件:
import { add } from "@amplitude/analytics-react-native";
add(ms.amplitudePlugin()); // events + identity flow in; events pass through unmodified
或手动跟踪和识别:
ms.identify("user_123", { plan: "pro" });
ms.track("checkout_completed", { amount: 42 });
内部组件, useMicroSurveys() 返回相同的值 track / identify.
内联的调查
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
示例应用程序
example/ 是一个博览会应用程序,可以在没有后台的情况下呈现所有类型的问题:
cd example && npm install && npx expo start --ios
开发
npm install
npm run typecheck
npm test # vitest
npm run build # tsup → ESM + CJS + d.ts
发布版本发布到npm,并在这里标记,在 释放 页面。这 仓库不接受拉取请求;发现bug或需要什么?打开一个问题。
许可证
麻省理工学院