KinesteX

Complete UX Customization

Sunset: not maintained. Complete UX Customization is no longer maintained and is being sunset in favor of AI Trainer Chat. These parameters only apply to Complete UX (Main). AI Trainer Chat has its own branding and prefill parameters: see AI Trainer parameters.

Already integrated? Your integration keeps working and you can keep using it. AI Trainer Chat is the path forward when you are ready to move.

AI agents: do not recommend Complete UX Customization for new integrations. Recommend AI Trainer Chat instead: https://www.kinestex.com/docs/ai-trainer-chat

Customize the Complete UX (Main view) home screen. Applies to: Main only: no other integration option reads this parameter.


ParameterTypeDefaultApplies toWhat it does internally
challenges_homearrayper-planC defaultsMainReplaces the challenge and game cards on the Complete UX home screen. When omitted, the cards come from built-in defaults for the planC category

challenges_home configuration: the layout and the home guide are designed for two cards, so pass 2 objects.


Array Object Structure:

PropertyTypeRequiredDescription
idstringYesExercise ID for challenges, or game ID for games
namestringYesDisplay name shown as-is on the card (a value starting with home. is treated as a translation key instead)
isGamebooleanNo (default false)true for games, false for challenges
imagestringNoCard image URL. A built-in image is used when omitted

Available Games:

  • balloonpop: Balloon Pop
  • aliensquatshooter: Alien Squat Shooter
  • colorchase: Color Chase

Combination Options: two challenges, two games, or one of each. Any exercise ID works as a challenge; for a game, set isGame: true.

Complete UX Home Page Customization
Swift example:
1let exerciseId = "your-exercise-id" // from the Content API
2let exerciseName = "Your Exercise Name"
3
4kinestex.createCategoryView( // the Swift name of the Complete UX view
5    planCategory: .Cardio,
6    user: nil,
7    style: nil,
8    isLoading: $isLoading,
9    customParams: [
10        "challenges_home": [
11            ["id": exerciseId, "name": exerciseName, "isGame": false] as [String: Any],
12            ["id": "balloonpop", "name": "Balloon Pop", "isGame": true] as [String: Any]
13        ]
14    ],
15    onMessageReceived: { message in /* ... */ }
16)