UI Controls
Control visibility and behavior of UI elements.
| Parameter | Type | Default | Applies to | What it does internally |
| isHideHeaderMain | boolean | false | Main, Plan, Personalized Plan, Workout, Challenge, Leaderboard, Assessments, AI Trainer | Hides the top header / back button on the listed screens. Note: on some screens the header is additionally gated by how the view was opened, so a back button may still appear when a screen is reached from inside the Complete UX home |
| hideFeelingDialog | boolean | false | Any flow ending on the statistics screen | Permanently suppresses the post-workout "How are you feeling?" emoji prompt (which otherwise appears on every 3rd completed session) |
| showSettings | boolean | true | Workout, Plan, Personalized Plan, Challenge, Assessments | When false, hides the settings gear button on the pre-workout detail screens (the settings modal itself stays available to internal flows) |
| hideCompletionOverlay | boolean | false | Workout player | Skips the full-screen animated completion summary (badge, confetti, farewell speech, auto-dismiss after ~5s) shown when a workout ends. When the overlay is dismissed normally, the SDK posts workout_completion_overlay_dismissed |
| preventGestureControl | boolean | false | Workout player | Disables in-exercise body controls: the hand-gesture pause/resume (T-pose then crossing forearms overhead) AND the auto-pause that triggers when the user leaves the camera frame for ~3.5s. Not applicable to Camera component, games, or assessments — they never have gesture control |
| disableGuide | boolean | false | Main, Plan, Workout, Challenge, Leaderboard | Suppresses the coach-mark tooltip tour (the step-by-step "tap here" overlay) on the home, plan, week, workout, exercise, challenge, leaderboard and settings screens |
| disableCookies | boolean | false | All | Declines analytics-cookie consent before any analytics call, switches analytics to memory-only persistence (nothing written to storage), and removes the cookie-preferences entries from the Settings modal and camera-access screen. Use for GDPR-sensitive embeds |
| hideStatisticsHeader | boolean | false | Statistics screen (FitPass-themed companies only) | Hides the top bar on the statistics screen. Only implemented in the FitPass statistics variant — companies on the default statistics layout always show the header regardless of this flag |
| nativeParentScroll | boolean | false | Statistics screen | Makes the statistics screen delegate scrolling to the native parent container (removes internal scroll and the top safe-area padding on the /statistic route only; the bottom padding stays). Enable if your native app wraps the WebView in its own scroll view |
| immediateShowSkip | boolean | false | Workout player | Shows the Skip button on the camera frame-positioning (silhouette) screen immediately with a themed background, instead of fading it in after ~5 seconds. Has no effect if Skip is disabled for the screen (the Camera component and the games never show Skip) |
| hideConnectTvButton | boolean | false | Workout player, Games, Camera | Hides the "Connect TV" (screen mirroring) button on the silhouette screen. Useful for kiosks and embeds where casting isn't available. Also accepted as a URL query param |
| checkFrameText | object | - | Workout player, Games, Camera | Replaces the text on the silhouette screen with your own. All keys are optional: moveBack ("Move back until your body fits the outline"), foundYou ("Found you!"), holdYourPosition ("Hold your position"), cantSeeFullBody ("Camera can't see your full body", shown after ~25s with no detection). Your text is shown as-is, not translated, so send it in the launch language. An empty string hides that line; a missing key keeps the default |
| legacyRestScreen | boolean | - | Workout, Plan, Personalized Plan, Challenge, Custom Workout | Picks the rest screen between exercises. false: the current design (centered countdown, "Up next" line, "+10 seconds" button). true: the previous design (mm:ss clock in the footer, numbered exercise title, no "+10 seconds"). Omitted: the current design, unless KinesteX set a different default for your company. Assessments always keep their own rest screen. Also accepted as a URL query param |
| hideOtherGender | boolean | false | Plan Onboarding, AI Trainer | Removes the "I'd rather not say" choice from the plan-onboarding gender step and the AI Trainer profile pickers, leaving only Male / Female. Also accepted as a URL query param |
| exitUrl | string | — | All (standalone/link integrations) | For launches with no host app: when the session ends, the browser is redirected to this URL after the exit_kinestex event is posted. Accepts https:// URLs or app deep links (e.g. clientapp://home); script-executing schemes (javascript:, data:) are rejected for security |
Skeleton drawing (`isDrawingPose`) is documented under Camera & Pose Detection.
UI Controls Configuration
Swift example:
1// Via customParams
2kinestex.createView(
3 customParams: [
4 "isHideHeaderMain": true,
5 "hideFeelingDialog": true,
6 "hideCompletionOverlay": true,
7 "preventGestureControl": true,
8 "disableGuide": true,
9 "disableCookies": true,
10 "hideStatisticsHeader": false,
11 "nativeParentScroll": false
12 ]
13)