From 5dd31685bbd3aa89b19f08f81a6a498f045d3acd Mon Sep 17 00:00:00 2001 From: Doug <6060466+pixlwave@users.noreply.github.com> Date: Fri, 4 Jul 2025 13:27:30 +0100 Subject: [PATCH] Rename the mobile_guide_app_variant config values to be clearer. (#30258) * Fix the default mobile_guide links. Whilst the script should update these if it fails these should link to Element X which is now the default app that we link out to from this page. * Rename the mobile_guide_app_variant values to be clearer. Also handle invalid config values by defaulting to Element X. * Rename snapshots to match new app variant identifiers. --- docs/config.md | 6 +++--- ...x.png => mobile-guide-element-classic-linux.png} | Bin ...e-x-linux.png => mobile-guide-element-linux.png} | Bin ...linux.png => mobile-guide-element-pro-linux.png} | Bin src/IConfigOptions.ts | 2 +- src/vector/mobile_guide/index.html | 8 ++++---- src/vector/mobile_guide/index.ts | 6 +++--- src/vector/mobile_guide/mobile-apps.ts | 6 +++--- 8 files changed, 14 insertions(+), 14 deletions(-) rename playwright/snapshots/mobile-guide/mobile-guide.spec.ts/{mobile-guide-classic-linux.png => mobile-guide-element-classic-linux.png} (100%) rename playwright/snapshots/mobile-guide/mobile-guide.spec.ts/{mobile-guide-x-linux.png => mobile-guide-element-linux.png} (100%) rename playwright/snapshots/mobile-guide/mobile-guide.spec.ts/{mobile-guide-pro-linux.png => mobile-guide-element-pro-linux.png} (100%) diff --git a/docs/config.md b/docs/config.md index b9e6f0f13a..2bc36e206f 100644 --- a/docs/config.md +++ b/docs/config.md @@ -132,9 +132,9 @@ complete re-branding/private labeling, a more personalised experience can be ach download the app instead. 8. `mobile_guide_app_variant`: Optional. The mobile app that the user is prompted to download from the `/mobile_guide` page. When omitted the mobile guide will be configured for the new Element X apps. Allowed values are as follows: - 1. `classic`: Element Android/iOS. - 2. `x`: Element X Android/iOS. - 3. `pro`: Element Pro Android/iOS. + 1. `element`: Element X Android/iOS. + 2. `element-classic`: Element Classic Android/iOS. + 3. `element-pro`: Element Pro Android/iOS. 9. `update_base_url`: For the desktop app only, the URL where to acquire update packages. If specified, must be a path to a directory containing `macos` and `win32` directories, with the update packages within. Defaults to `https://packages.element.io/desktop/update/` in production. diff --git a/playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-classic-linux.png b/playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-element-classic-linux.png similarity index 100% rename from playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-classic-linux.png rename to playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-element-classic-linux.png diff --git a/playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-x-linux.png b/playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-element-linux.png similarity index 100% rename from playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-x-linux.png rename to playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-element-linux.png diff --git a/playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-pro-linux.png b/playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-element-pro-linux.png similarity index 100% rename from playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-pro-linux.png rename to playwright/snapshots/mobile-guide/mobile-guide.spec.ts/mobile-guide-element-pro-linux.png diff --git a/src/IConfigOptions.ts b/src/IConfigOptions.ts index 2e129f1186..952d35e88d 100644 --- a/src/IConfigOptions.ts +++ b/src/IConfigOptions.ts @@ -81,7 +81,7 @@ export interface IConfigOptions { }; mobile_guide_toast?: boolean; - mobile_guide_app_variant?: "classic" | "x" | "pro"; + mobile_guide_app_variant?: "element" | "element-classic" | "element-pro"; default_theme?: "light" | "dark" | string; // custom themes are strings default_country_code?: string; // ISO 3166 alpha2 country code diff --git a/src/vector/mobile_guide/index.html b/src/vector/mobile_guide/index.html index 34c3c4cc4a..3bd8a8e20d 100644 --- a/src/vector/mobile_guide/index.html +++ b/src/vector/mobile_guide/index.html @@ -7,7 +7,7 @@ Element Mobile Guide - + @@ -44,7 +44,7 @@

Download Element

Also available on { const defaultHsUrl = config?.["default_hs_url"]; const defaultIsUrl = config?.["default_is_url"]; - const appVariant = (config?.["mobile_guide_app_variant"] ?? "x") as MobileAppVariant; - const metadata = mobileApps[appVariant]; + const appVariant = (config?.["mobile_guide_app_variant"] as MobileAppVariant) ?? MobileAppVariant.X; + const metadata = mobileApps[appVariant] ?? mobileApps[MobileAppVariant.X]; // Additional fallback in case mobile_guide_app_variant has an unexpected value. const incompatibleOptions = [wkConfig, serverName, defaultHsUrl].filter((i) => !!i); if (defaultHsUrl && (wkConfig || serverName)) { diff --git a/src/vector/mobile_guide/mobile-apps.ts b/src/vector/mobile_guide/mobile-apps.ts index ab2ff2240a..ff3430d6b7 100644 --- a/src/vector/mobile_guide/mobile-apps.ts +++ b/src/vector/mobile_guide/mobile-apps.ts @@ -10,9 +10,9 @@ Please see LICENSE files in the repository root for full details. */ export enum MobileAppVariant { - Classic = "classic", - X = "x", - Pro = "pro", + Classic = "element-classic", + X = "element", + Pro = "element-pro", } export interface MobileAppMetadata {