UI Controls
Control the visibility and behavior of UI elements.
| Parameter | Type | Default | Applies to | What it does internally |
| isHideHeaderMain | boolean | false | Main, Plan, Personalized Plan, Workout, Challenge, Training, Leaderboard, Assessments, AI Trainer | Hides the top header and back button on these screens. On some screens the header also depends on how the screen was opened, so a back button can still appear when the screen is reached from inside the Complete UX home |
| hideFeelingDialog | boolean | false | Any flow ending on the results screen | Never shows the post-workout "How are you feeling?" prompt (which otherwise appears on every 3rd completed session) |
| showSettings | boolean | true | Workout, Plan, Personalized Plan, Challenge, Assessments, Gym Log, AI Trainer | When false, hides the settings gear on the workout detail, exercise and Gym Log screens and on the challenge and assessment intro screens. In the AI Trainer it replaces the chat's settings button (music, AI motion tracking, pose model) with a plain profile button, unless hideProfileButton is set |
| hideCompletionOverlay | boolean | false | Workout player | Skips the full-screen completion summary (badge, confetti, farewell speech) shown when a workout ends. When the overlay is shown and dismissed, the SDK posts workout_completion_overlay_dismissed |
| preventGestureControl | boolean | false | Workout player | Turns off the in-exercise body controls: the hands gesture that pauses and resumes the workout, AND the pause when the user leaves the camera frame. Challenge and the Box and Training experiences never use them |
| disableGuide | boolean | false | Main, Plan, Workout, Challenge, Leaderboard | Turns off the coach-mark tooltip tour (the step-by-step "tap here" overlay) |
| disableCookies | boolean | false | All | Declines analytics cookies before any analytics call, keeps analytics in memory only (nothing written to storage) and removes the cookie-preference entries from the Settings modal, the camera-access screen and the AI Trainer. Use it for GDPR-sensitive embeds |
| hideStatisticsHeader | boolean | false | Results screen (workouts and challenges) | Hides the top bar of the results screen. The Box experience keeps its own layout |
| nativeParentScroll | boolean | false | Results screen | Lets the native parent container scroll the results screen (the /statistic route stops scrolling internally and drops its top safe-area padding). Enable it if your app wraps the WebView in its own scroll view |
| immediateShowSkip | boolean | false | Workout player | Shows the Skip button on the positioning (check frame) screen at once, with a themed background, instead of fading it in after about 5 seconds. No effect where Skip is not offered (the Camera component and the games) |
| hideConnectTvButton | boolean | false | Workout player, Games, Camera | Hides the "Connect TV" (screen mirroring) button on the positioning screen. Useful for kiosks and embeds where casting is not available |
| checkFrameText | object | none | Workout player, Games, Camera | Replaces the text on the positioning screen. 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 20s after the screen opens without a full-body match, counted once tracking has started). 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 | company default | 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 keep their own rest screen |
| 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 Male and Female |
URL launches: hideCompletionOverlay, disableGuide, disableCookies, hideStatisticsHeader, preventGestureControl and immediateShowSkip must be real booleans: send them by postMessage or inside ?data= (URL Parameters).
Related: skeleton drawing (isDrawingPose) is under Camera & Pose Detection; exitUrl is under Navigation.
UI Controls Configuration
Swift example:
1kinestex.createWorkoutView( // same customParams on every create*View method
2 workout: "Fitness Lite",
3 user: nil,
4 style: nil,
5 isLoading: $isLoading,
6 customParams: [
7 "isHideHeaderMain": true,
8 "hideFeelingDialog": true,
9 "hideCompletionOverlay": true,
10 "preventGestureControl": true,
11 "disableGuide": true,
12 "disableCookies": true,
13 "hideConnectTvButton": true,
14 "checkFrameText": ["foundYou": "Great, we see you!"]
15 ],
16 onMessageReceived: { message in /* ... */ }
17)