Repository navigation
docs(react-native): document @posthog/react-native-plugin 3.0 requirements - #20922
turnipdabeets wants to merge 21 commits into
Conversation
Deploy preview
Changed pages
|
|
Vale prose linter → found 0 errors, 95 warnings, 10 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 5:12 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 5:38 | warning | Use 'X' instead of 'x'. | Vale.Terms |
contents/docs/error-tracking/installation/react-native.mdx — 0 errors, 2 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 28:705 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 30:308 | warning | Use 'X' instead of 'x'. | Vale.Terms |
contents/docs/error-tracking/upload-source-maps/react-native.mdx — 0 errors, 22 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 13:246 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 13:252 | warning | 'tracking's' is a possible misspelling. | PostHogBase.Spelling |
| 108:41 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 122:598 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 140:58 | warning | 'symbolicate' is a possible misspelling. | PostHogBase.Spelling |
| 160:40 | warning | 'gitignored' is a possible misspelling. | PostHogBase.Spelling |
| 218:90 | warning | 'Sandboxing' is a possible misspelling. | PostHogBase.Spelling |
| 224:58 | warning | 'symbolicate' is a possible misspelling. | PostHogBase.Spelling |
| 230:48 | warning | 'dSYMs' is a possible misspelling. | PostHogBase.Spelling |
| 230:56 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 230:64 | warning | Use 'iOS' instead of 'ios'. | Vale.Terms |
| 231:233 | warning | Use 'ID' instead of 'id'. | Vale.Terms |
| 242:1 | warning | 'Symbolicated' is a possible misspelling. | PostHogBase.Spelling |
| 246:93 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 276:335 | warning | 'classpath' is a possible misspelling. | PostHogBase.Spelling |
| 297:537 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 313:93 | warning | 'dSYMs' is a possible misspelling. | PostHogBase.Spelling |
| 314:17 | warning | 'Sandboxing' is a possible misspelling. | PostHogBase.Spelling |
| 314:100 | warning | 'dSYMs' is a possible misspelling. | PostHogBase.Spelling |
| 353:73 | warning | Use 'ID' instead of 'id'. | Vale.Terms |
| 353:144 | warning | 'deobfuscated' is a possible misspelling. | PostHogBase.Spelling |
| 379:458 | warning | 'sandboxing' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/libraries/react-native/index.mdx — 0 errors, 64 warnings, 10 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 6:18 | warning | Use 'GitHub' instead of 'github'. | Vale.Terms |
| 6:37 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 42:82 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 50:3 | warning | 'CocoaPods' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 51:97 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 54:126 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 65:12 | warning | 'podspec' is a possible misspelling. | PostHogBase.Spelling |
| 65:142 | warning | 'podspec' is a possible misspelling. | PostHogBase.Spelling |
| 67:1 | warning | 'CocoaPods with *********** through Swift Package Manager' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 69:55 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 94:6 | warning | 'Full Swift Package Manager' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 96:211 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 106:243 | warning | 'podspec's' is a possible misspelling. | PostHogBase.Spelling |
| 127:168 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 128:125 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 130:157 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 139:254 | warning | 'Backgrounded' is a possible misspelling. | PostHogBase.Spelling |
| 140:171 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 141:129 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 142:109 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 144:150 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 148:171 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 176:19 | warning | 'Backgrounded' is a possible misspelling. | PostHogBase.Spelling |
| 176:78 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 179:24 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 180:42 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 217:119 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 330:274 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 334:5 | warning | '$set' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 340:5 | warning | '$set_once' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 342:75 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 365:49 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 367:23 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 379:69 | warning | Avoid trivializing words. 'simply' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 438:10 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 438:94 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 438:103 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 509:17 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 511:89 | warning | 'refetches' is a possible misspelling. | PostHogBase.Spelling |
| 542:8 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 542:55 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 542:128 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 544:28 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 544:54 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 552:4 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 552:4 | warning | 'Error tracking' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 554:11 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 554:52 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 583:132 | warning | 'symbolication' is a possible misspelling. | PostHogBase.Spelling |
| 620:163 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 663:12 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 667:4 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 667:4 | warning | 'Session replay' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 669:12 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 669:74 | warning | Avoid trivializing words. 'all you need to do' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 669:133 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 673:11 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 683:62 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 683:100 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 685:126 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 746:124 | warning | 'Podfile' is a possible misspelling. | PostHogBase.Spelling |
| 746:162 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 746:405 | warning | 'Podfile' is a possible misspelling. | PostHogBase.Spelling |
| 747:16 | warning | 'Podfile' is a possible misspelling. | PostHogBase.Spelling |
| 750:73 | warning | 'Podfile' is a possible misspelling. | PostHogBase.Spelling |
| 750:198 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 750:369 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 769:25 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 777:191 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 783:107 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 790:393 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 792:1 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 794:96 | warning | 'unclipped' is a possible misspelling. | PostHogBase.Spelling |
| 796:4 | warning | 'Upgrading from V1, V2 to V3 or V3 to V4' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
contents/docs/session-replay/installation/react-native.mdx — 0 errors, 5 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 31:39 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 36:308 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 40:6 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 40:27 | warning | 'janky' is a possible misspelling. | PostHogBase.Spelling |
| 40:88 | warning | 'iPhones' is a possible misspelling. | PostHogBase.Spelling |
Bundle reportTotal JS (gzip)12.22 MiB (-0.1 KiB / -0.0%) Eager graph (modules shipped in each entrypoint's initial chunks)
Largest modules in the
|
| Module | Size |
|---|---|
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css |
1023.1 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/puzzle.mjs |
388.5 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js |
354.8 KiB |
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules |
351.4 KiB |
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/basketball-coach.mjs |
337.4 KiB |
./node_modules/.pnpm/framer-motion@14.0.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/framer-motion/dist/es/render/components/motion/proxy.mjs + 126 modules |
287.2 KiB |
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
./src/components/SearchUI/index.tsx + 87 modules |
273.1 KiB |
./gatsby-browser.tsx + 60 modules |
259.4 KiB |
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/construction-1.mjs |
248.5 KiB |
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules |
240.2 KiB |
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/construction-2.mjs |
228.2 KiB |
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/magnifying-glass.mjs |
221.7 KiB |
./src/hooks/useProduct.ts + 18 modules |
166.5 KiB |
Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes for the modules actually shipped in the entrypoint's initial chunks (post-tree-shake).
|
This PR hasn't seen activity in two weeks! Should it be merged, closed, or further worked on? If you want to keep it open, please remove the |
Covers PostHog/posthog-js#5449: posthog-ios always comes from SwiftPM, and screenshotModeBackgroundCapture is ignored on iOS.
There was a problem hiding this comment.
PostHog Review · Standard · reviewed 60a9b00: 3 Should fix.
This is the only automatic review while this pull request is a draft. Comment @posthog review to review new changes sooner. Otherwise, a review of the new changes runs when you mark it ready for review.
See this review and its findings in PostHog Review. Comment @posthog review --deep for a Deep review. A Deep review takes longer and looks deeper than a Standard review.
…art() callers Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keep the CocoaPods read-only notice, reworded for plugin 3.0 (SPM by default; the hybrid path is 2.x only), and add the capture v1 proxy note for native iOS events on posthog-ios 4.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…pgrade Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… fix 2.x iOS advice - Remove posthog-react-native-session-replay and pod 'PostHog' before upgrading; plugin 3.0's pod install stops otherwise (posthog-js#5608) - CocoaPods notice: plugin 2.x pins posthog-ios 3.92.x on every path, so upgrade to 3.0 for posthog-ios 4.x - Say plugin 3.0 ignores screenshotModeBackgroundCapture in the session replay tip - Document posthog.setAppLanguage() (posthog-js#5601)
…, cover Expo 52 prebuild and full SwiftPM
…d the 4.0.x pin Claude-Session: https://claude.ai/code/session_019xLynttdFZAHfqTem5BhPQ
It documents posthog-react-native 4.86.0, which has shipped.
|
#22061 lands before this PR. It deletes
|
posthog-ios 4.0 kept the option (PostHog/posthog-ios#1052), and $locale and iOS masking notes now match the plugin's migration guide.
|
Thanks, eli-r-ph. #22061 doesn't delete this page any more. The mobile part moved to #22334, which waits for posthog-react-native 5.0. #22061 now changes only two @gewenyu99, a heads-up for #22334: it already moves the |
…s show Code tab labels stop at the first space, so the version qualifiers never rendered.
Changes
Documents
@posthog/react-native-plugin3.0 (PostHog/posthog-js#5194, with PostHog/posthog-js#5237, PostHog/posthog-js#5236 and PostHog/posthog-js#5449), which adopts posthog-ios 4.0 (PostHog/posthog-ios#873) and posthog-android 4.0 (PostHog/posthog-android#871, PostHog/posthog-js#5476):Requirements for 3.0 and later: React Native 0.75+, Xcode 26+ (from posthog-ios 4.0), and iOS 15+ / macOS 11+ on every iOS dependency path. The 2.x requirements stay, marked as applying to earlier versions.
Android: Kotlin 2.0 or later for React Native 0.75/0.76 apps (Expo SDK 52 included, with the
prebuild --cleancaveat), and native code or libraries that call posthog-android 3.x APIs must move to 4.0 (otherwiseNoSuchMethodErrorat runtime). Capture v1, the proxy rules and the$localechange below apply to Android as well as iOS.A short "Upgrading to
@posthog/react-native-plugin3.0" section: no code changes for apps that use the plugin throughposthog-react-native. Direct callers switch fromstart()tosetup()and passthrottleDelayMs.iOS native uploads (session replay, crash reports) pause while cellular data is turned off for the app.
From 3.0 the CocoaPods path resolves
posthog-iosthrough Swift Package Manager (chore(react-native-plugin)!: resolve posthog-ios through Swift Package Manager posthog-js#5449). Theposthog.useSpmhybrid path is marked 2.x only, and the upgrade section says to remove the property, that dynamic frameworks are no longer needed, and to drop the legacyposthog-react-native-session-replaypackage (it pinsposthog-ios3.x).The upgrade section also covers Podfile settings that now fail
pod install, GitHub access for build machines,import PostHogin app targets (conditional wording, not tested) and custom dSYM upload scripts, and links the plugin's migration guide.sessionReplayConfig.screenshotModeBackgroundCapturekeeps working in 3.0, because posthog-ios 4.0 kept it (feat: keep screenshotModeBackgroundCapture in 4.0 posthog-ios#1052), so the session replay troubleshooting tip is unchanged.Native event changes in 3.0: rage clicks go to capture v1 too, 404 retry and queue eviction, native events with an empty, whitespace-only or over-200-byte distinct ID are dropped (JavaScript events keep it, so a JWT distinct ID loses only native events), iOS omits
nullproperties and Android keepsnulllist elements, Android$localecodeshe/id/yi, and the multi-project$app_languagerule.The 3.0 section links to "Setting the app language" (
posthog.setAppLanguage()), which shipped separately in docs(react-native): document setAppLanguage() #22285 (merged) becauseposthog-react-native4.86.0 is already out. The anchor resolves onmaster.React Native source maps page: the dSYM script tabs are now CocoaPods and SwiftPM, and the text says plugin 3.0 uses the SwiftPM path on every iOS dependency path. The old labels (
CocoaPods (plugin 2.x),Swift Package Manager (and plugin 3.0 and later)) rendered asCocoaPodsandSwift, because code tab labels stop at the first space, so the version scope never showed.Punctuation only, on the React Native source maps page: em dashes become en dashes and a curly apostrophe becomes a straight one, per the style guide.
iOS 4.0 masking changes, the
Redefinition of module 'PostHog'failure from other pods that depend onPostHog, native surveys left out of full SwiftPM apps (fix(react-native-plugin): keep native surveys off when another package enables the Surveys trait posthog-js#5639), and the plugin's 4.0.xposthog-iospin.Merge only after
@posthog/react-native-plugin3.0.0 is released. The PRs this page depends on (PostHog/posthog-js#5237, #5476, #5236, #5449, #5639, PostHog/posthog-android#908 and PostHog/posthog-ios#909) are all merged into the 3.0 / 4.0 branches. The links to the native migration guides point atmainand resolve once posthog-ios 4.0 and posthog-android 4.0 merge. The plugin's own migration guide also covers rolling back to 2.x and the strict[4.0.0, 5.0.0)posthog-android range; this page links to it rather than repeating them.Checklist
vercel.json(n/a)🤖 Generated with Claude Code