Leaderboard
Configure leaderboard functionality.
| Parameter | Type | Default | Description | Effect |
| showLeaderboard | boolean | - | Show leaderboard UI | Enables/disables leaderboard visibility |
| username | string | - | Display name for leaderboard | Sets the user's name shown on leaderboards |
| autoSubmitLeaderboard | boolean | false | Silent leaderboard submission (Challenge only) | When true, Challenge results are submitted to the leaderboard without showing the submission modal. The display name is read from the previously stored leaderboard_username (or falls back to the user ID) |
Note: Username is automatically saved to localStorage for future sessions.
`autoSubmitLeaderboard` use case: Use this only for Challenge integrations where you want every completion silently posted to the leaderboard (e.g., when your host app already manages display names and doesn't want a second prompt). Leave it unset (or false) to keep the standard modal-based flow.
Leaderboard Configuration
1// Via customParams
2kinestex.createView(
3 customParams: [
4 "showLeaderboard": true,
5 "username": "FitnessPro123",
6 "autoSubmitLeaderboard": true // Challenge-only: skip submit modal
7 ]
8)