Skip to content

docs(replay): document React Native Android screenshot controls - #20017

Closed
dustinbyrne wants to merge 3 commits into
masterfrom
docs/react-native-replay-screenshot-controls
Closed

dustinbyrne wants to merge 3 commits into
masterfrom
docs/react-native-replay-screenshot-controls

Conversation

@dustinbyrne

Copy link
Copy Markdown
Contributor

Changes

Prepare documentation for the React Native exposure of the Android #761 screenshot controls.

  • Describe three independent experimental controls: screenshotScale, screenshotCompressionQuality, and screenshotColorMode.
  • Show a provider example and explain Android defaults, valid ranges, and image-quality trade-offs.
  • State the native-plugin requirement and Android-only scope.

This is a documentation draft for an upcoming SDK change. The wrapper does not expose these controls yet. The option names assume parity with Android. The color-mode table describes native formats, not a confirmed TypeScript value type.

Source checked: PostHog/posthog-android at defdd171fe7a815d374aca9bf01a5c1d53cfb3af.

Related documentation: Android draft #20016.

Validation

  • pnpm format:docs and focused Markdown lint passed.
  • The Gatsby MDX compiler (@mdx-js/mdx 1.6.22) compiled the page and its option table.
  • Internal links and tab names were checked against repository content.
  • A fresh read-only review checked the documentation against the Android source and current wrapper configuration.
  • GATSBY_MINIMAL=true pnpm start: the page, option table, and example rendered in the browser. There were no uncaught errors. Console diagnostics matched the unchanged page.

Before merge

  • Confirm the final React Native option names, types, and color-mode values against the SDK implementation.
  • Type-check the example against the updated SDK.
  • Release native-plugin support and the React Native configuration changes. Add the minimum versions to this page.
  • Check the rendered page and browser console in the site preview.

Checklist

  • I read the docs and content style guides.
  • Words use American English.
  • Internal links use relative URLs.

@github-actions github-actions Bot added docs Improvements or additions to product documentation, "Docs" content PR only touches files under contents/ labels Sep 8, 2026
@github-actions

github-actions Bot commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Sep 08, 2026 10:04PM

@github-actions

github-actions Bot commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 1 errors, 4 warnings, 0 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/session-replay/installation/react-native.mdx — 1 errors, 4 warnings, 0 suggestions
Line Severity Message Rule
59:41 warning 'lossy' is a possible misspelling. PostHogBase.Spelling
71:41 error 'native' is repeated! Vale.Repetition
75:6 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
75:27 warning 'janky' is a possible misspelling. PostHogBase.Spelling
75:88 warning 'iPhones' is a possible misspelling. PostHogBase.Spelling

@github-actions

github-actions Bot commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

8.85 MiB (+0.4 KiB / +0.0%)

Eager graph (modules shipped in each entrypoint's initial chunks)

Entrypoint Eager size Budget Modules
✅ app 18.44 MiB (+4.2 KiB / +0.0%) report-only 2053
Largest modules in the app closure
Module Size
./src/data/mcp-tools.json 1100.8 KiB
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 757.9 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js 481.4 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/x-ray.mjs 480.8 KiB
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules 395.1 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/im-the-driver.mjs 385.7 KiB
./src/hooks/useCustomers.tsx + 55 modules 370.0 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
./src/components/ProductComparisonTable/index.tsx + 126 modules 302.5 KiB
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js 281.9 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/doll-house.mjs 281.7 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/director.mjs 275.6 KiB
./src/components/SearchUI/index.tsx + 87 modules 273.0 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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content PR only touches files under contents/ docs Improvements or additions to product documentation, "Docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant