docs: mark React Native autocapture as experimental (beta) - #453
Open
rahul-mixpanel wants to merge 1 commit into
Open
docs: mark React Native autocapture as experimental (beta)#453rahul-mixpanel wants to merge 1 commit into
rahul-mixpanel wants to merge 1 commit into
Conversation
React Native developers never see the native SDKs' documentation, so the beta status of autocapture was invisible on this side. This mirrors what mixpanel-android#999 and mixpanel-swift#768 do for the native surfaces, with the same wording. - @experimental JSDoc on the autocapture typings: AutocaptureOptions and its three sub-interfaces, ClickEventData, the Autocapture class, and Mixpanel#autocapture - the same note on the Autocapture class and the autocapture getter in index.js, so it shows in editor hovers for JavaScript consumers too - a short callout near the top of the README, so it is stated outside code as well No runtime warning is added here: enabling autocapture goes through the native SDKs, which already log one when it starts, and duplicating it in JS would print it twice. Documentation only — no API or behaviour change. The package's jest suite is unchanged at 298 passing, with the same 8 pre-existing failures before and after (verified by stashing). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Confidence Score: 5/5The PR appears safe to merge. The changes are documentation-only, consistently describe autocapture as beta, and do not alter runtime behavior or public type signatures.
|
| Filename | Overview |
|---|---|
| README.md | Adds a prominent, accurate beta-status callout for autocapture. |
| index.d.ts | Adds consistent experimental annotations to autocapture typings and the Mixpanel accessor. |
| index.js | Adds matching experimental JSDoc to the autocapture class and getter without runtime changes. |
Reviews (1): Last reviewed commit: "docs: mark React Native autocapture as e..." | Re-trigger Greptile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
React Native developers never see the native SDKs' documentation, so autocapture's beta status was invisible on this side. This mirrors mixpanel-android#999 and mixpanel-swift#768, with the same wording.
Stacked on #452 — merges into
feat/autocapture-sample-el-id-screens.What changed
@experimentalJSDoc on the autocapture typings inindex.d.ts:AutocaptureOptionsand its three sub-interfaces,ClickEventData, theAutocaptureclass, andMixpanel#autocaptureAutocaptureclass and theautocapturegetter inindex.js, so it appears in editor hovers for JavaScript consumers tooNo runtime warning is added here on purpose: enabling autocapture goes through the native SDKs, which already log one when it starts, so emitting from JS as well would print it twice.
Documentation only — no API or behaviour change.
One gap this PR does not close
index.js:902still mapsclickEvent.accessibleLabelonto$attr-aria-labelfor manualtrackClickcalls, andClickEventData.accessibleLabelis still in the typings. Both native SDKs stopped capturing and reporting that property (mixpanel-android#997, mixpanel-swift#767) because accessibility labels are localized and can carry user data — so the JS wrapper can currently reintroduce, by hand, the exact property that was deliberately removed.Fixing it means removing
accessibleLabelfromClickEventDataand the property mapping, which is a JS API change and belongs with the label-removal work rather than a docs PR. Happy to open it as a follow-up.Testing
The package's jest suite is unchanged: 298 passing, with the same 8 pre-existing failures before and after — verified by stashing these changes and re-running.
🤖 Generated with Claude Code