Skip to content

docs(replay): drop wireframe mode from mobile replay onboarding #125537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
turnipdabeets wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −24
Draft

docs(replay): drop wireframe mode from mobile replay onboarding #125537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/onboarding/session-replay/android.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,11 @@ export const getAndroidSteps = (ctx: OnboardingComponentsContext): StepDefinitio
// requires SDK version 3.32.0 or higher.
config.sessionReplayConfig.captureLogcat = true

// Whether replays are created using high quality screenshots. Default is false.
// If disabled, replays are created using wireframes instead.
// The screenshot may contain sensitive information, so use with caution
config.sessionReplayConfig.screenshot = false
// Replays are recorded as masked screenshots, so mask anything sensitive.
// Before SDK version 4.0, also set config.sessionReplayConfig.screenshot = true,
// otherwise replays are recorded as wireframes.

// Experimental screenshot settings require SDK 3.63.0+ and screenshot = true.
// Experimental screenshot settings require SDK version 3.63.0 or higher.
// We recommend the values below to balance performance and image quality.
// Lower resolution and RGB_565 reduce capture time and memory use.

Expand Down
19 changes: 5 additions & 14 deletions docs/onboarding/session-replay/ios.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,18 +111,9 @@ export const getIOSSteps = (ctx: OnboardingComponentsContext): StepDefinition[]
// requires SDK version 3.41.1 or higher.
config.sessionReplayConfig.captureNetworkTelemetry = true

// Whether replays are created using high quality screenshots. Default is false.
// Required for SwiftUI.
// If disabled, replays are created using wireframes instead.
// The screenshot may contain sensitive information, so use with caution
config.sessionReplayConfig.screenshotMode = true

// Experimental. Only applies when \`screenshotMode\` is enabled.
// Moves screenshot rendering off the main thread, which reduces jank
// on high refresh rate (120Hz ProMotion) displays. May trigger Xcode's
// Main Thread Checker and briefly freeze the app on the first capture.
// Default is false. Requires SDK version 3.58.1 or higher.
config.sessionReplayConfig.screenshotModeBackgroundCapture = false
// Replays are recorded as masked screenshots, so mask anything sensitive.
// Before SDK version 4.0, also set config.sessionReplayConfig.screenshotMode = true,
// otherwise replays are recorded as wireframes and SwiftUI screens aren't recorded.

// Minimum time (in seconds) between snapshots. Default is 1.0s.
// Snapshots are taken when views lay out, so this caps how often one
Expand Down Expand Up @@ -156,8 +147,8 @@ export const getIOSSteps = (ctx: OnboardingComponentsContext): StepDefinition[]
</Markdown>
<CalloutBox type="fyi" title="SwiftUI support">
<Markdown>
SwiftUI is only supported if the `screenshotMode` option is enabled. Custom views and
WebViews also require screenshot mode for full support.
SDK version 4.0 and later record SwiftUI, custom views and WebViews as screenshots. Earlier
versions only support them if the `screenshotMode` option is enabled.
</Markdown>
</CalloutBox>
</>
Expand Down
5 changes: 0 additions & 5 deletions docs/onboarding/session-replay/kmp.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,6 @@ export const getKMPSteps = (ctx: OnboardingComponentsContext): StepDefinition[]
// Capture console and system logs (iOS and web). Default is false.
captureLogs = false,

// Whether replays are created using high quality screenshots instead of
// wireframes (experimental, Android and iOS). Default is false.
// Screenshots may contain sensitive information, so use with caution.
screenshot = false,

// Capture Android logcat output (Android only). Default is true.
captureLogcat = true,

Expand Down
Loading