Skip to content

Commit e89136d

Browse files
noisysocksmgurgel
authored andcommitted
Document onboarding test URL parameters
1 parent 2c458ae commit e89136d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

special-pages/pages/onboarding/readme.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,17 @@ Don't edit the generated files directly - any changes you make will not be refle
3636

3737
Instead, make your changes in `src/' and then run `npm run build.pages` from the `packages/special-pages` folder
3838

39+
### Test URL params
40+
41+
URL parameters can be used to override the default values of the onboarding flow's configuration. Supported parameters are:
42+
43+
- `locale` - Specifies the language to use for translations. Expects a language code (e.g., `en`, `de`, `fr`).
44+
45+
- `locale` - Specifies the language to use for translations. Expects a language code (e.g., `en`, `de`, `fr`).
46+
- `textLength` - Adjusts the length of translated strings, for testing layout with different text sizes (e.g., `short`, `long`).
47+
- `display` - Controls which view is rendered. `app` renders the main onboarding flow, `components` renders the component showcase page.
48+
- `platform` - Overrides the detected platform, for testing platform-specific styling (e.g., `macos`, `windows`).
49+
- `order` - Specifies which predefined set of onboarding steps to use (e.g., `v1`, `v2`, `v3`).
50+
- `exclude` - Removes specific steps from the onboarding flow. Can be used multiple times (e.g., `&exclude=welcome&exclude=systemSettings`).
51+
- `page` - Sets the initial step to start the onboarding flow on (e.g., `systemSettings`).
52+
- `adBlocking` - If set to `enabled`, adds a step for enabling ad blocking. If set to `youtube`, adds a step for enabling YouTube-only ad blocking.

0 commit comments

Comments
 (0)