2017-11-03 23:19:45 -06:00
|
|
|
/*
|
2025-03-14 12:03:09 +00:00
|
|
|
Copyright 2024, 2025 New Vector Ltd.
|
2024-09-09 14:57:16 +01:00
|
|
|
Copyright 2018-2024 The Matrix.org Foundation C.I.C.
|
2017-11-03 23:19:45 -06:00
|
|
|
Copyright 2017 Travis Ralston
|
|
|
|
|
|
2025-01-06 11:18:54 +00:00
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
2024-09-09 14:57:16 +01:00
|
|
|
Please see LICENSE files in the repository root for full details.
|
2017-11-03 23:19:45 -06:00
|
|
|
*/
|
|
|
|
|
|
2025-02-05 13:25:06 +00:00
|
|
|
import React, { type ReactNode } from "react";
|
2025-09-02 09:41:49 +01:00
|
|
|
import { STABLE_MSC4133_EXTENDED_PROFILES, UNSTABLE_MSC4133_EXTENDED_PROFILES } from "matrix-js-sdk/src/matrix";
|
2025-11-03 16:26:47 +00:00
|
|
|
// Import these directly from shared-components to avoid circular deps
|
2026-01-07 11:49:01 +00:00
|
|
|
import { _t, _td } from "@element-hq/web-shared-components";
|
2020-03-25 18:38:12 +00:00
|
|
|
|
2025-04-22 10:37:47 +01:00
|
|
|
import { type MediaPreviewConfig } from "../@types/media_preview.ts";
|
2024-09-30 11:29:14 +01:00
|
|
|
import DeviceIsolationModeController from "./controllers/DeviceIsolationModeController.ts";
|
2017-11-04 22:28:35 -07:00
|
|
|
import {
|
|
|
|
|
NotificationBodyEnabledController,
|
|
|
|
|
NotificationsEnabledController,
|
|
|
|
|
} from "./controllers/NotificationControllers";
|
2019-02-11 18:10:00 +00:00
|
|
|
import ThemeController from "./controllers/ThemeController";
|
2019-11-15 11:31:19 +00:00
|
|
|
import ReloadOnChangeController from "./controllers/ReloadOnChangeController";
|
2020-04-14 16:18:57 +01:00
|
|
|
import FontSizeController from "./controllers/FontSizeController";
|
2020-06-15 15:33:52 +01:00
|
|
|
import SystemFontController from "./controllers/SystemFontController";
|
2020-07-28 12:02:02 -06:00
|
|
|
import { SettingLevel } from "./SettingLevel";
|
2025-02-05 13:25:06 +00:00
|
|
|
import type SettingController from "./controllers/SettingController";
|
2022-05-03 22:04:37 +01:00
|
|
|
import { IS_MAC } from "../Keyboard";
|
2020-09-14 22:27:40 -06:00
|
|
|
import UIFeatureController from "./controllers/UIFeatureController";
|
|
|
|
|
import { UIFeature } from "./UIFeature";
|
2021-11-17 08:19:30 -07:00
|
|
|
import { Layout } from "./enums/Layout";
|
2021-02-17 17:43:31 +00:00
|
|
|
import ReducedMotionController from "./controllers/ReducedMotionController";
|
2021-02-19 13:06:45 +00:00
|
|
|
import IncompatibleController from "./controllers/IncompatibleController";
|
2021-11-17 08:19:30 -07:00
|
|
|
import { ImageSize } from "./enums/ImageSize";
|
2021-11-11 13:07:41 +00:00
|
|
|
import { MetaSpace } from "../stores/spaces";
|
2022-02-08 14:02:36 +00:00
|
|
|
import SdkConfig from "../SdkConfig";
|
2022-09-07 16:42:39 +01:00
|
|
|
import SlidingSyncController from "./controllers/SlidingSyncController";
|
2022-05-26 09:56:53 +01:00
|
|
|
import { FontWatcher } from "./watchers/FontWatcher";
|
2023-03-03 13:31:51 +00:00
|
|
|
import ServerSupportUnstableFeatureController from "./controllers/ServerSupportUnstableFeatureController";
|
|
|
|
|
import { WatchManager } from "./WatchManager";
|
2025-02-05 13:25:06 +00:00
|
|
|
import { type CustomTheme } from "../theme";
|
2024-04-22 17:15:29 +01:00
|
|
|
import AnalyticsController from "./controllers/AnalyticsController";
|
2024-10-02 15:08:15 +01:00
|
|
|
import FallbackIceServerController from "./controllers/FallbackIceServerController";
|
2025-02-05 13:25:06 +00:00
|
|
|
import { type IRightPanelForRoomStored } from "../stores/right-panel/RightPanelStoreIPanelState.ts";
|
|
|
|
|
import { type ILayoutSettings } from "../stores/widgets/WidgetLayoutStore.ts";
|
|
|
|
|
import { type ReleaseAnnouncementData } from "../stores/ReleaseAnnouncementStore.ts";
|
|
|
|
|
import { type Json, type JsonValue } from "../@types/json.ts";
|
|
|
|
|
import { type RecentEmojiData } from "../emojipicker/recent.ts";
|
|
|
|
|
import { type Assignable } from "../@types/common.ts";
|
2025-03-14 15:11:04 +05:30
|
|
|
import { SortingAlgorithm } from "../stores/room-list-v3/skip-list/sorters/index.ts";
|
2025-04-22 10:37:47 +01:00
|
|
|
import MediaPreviewConfigController from "./controllers/MediaPreviewConfigController.ts";
|
2025-06-10 11:47:33 +01:00
|
|
|
import InviteRulesConfigController from "./controllers/InviteRulesConfigController.ts";
|
|
|
|
|
import { type ComputedInviteConfig } from "../@types/invite-rules.ts";
|
2025-11-27 18:42:58 +00:00
|
|
|
import BlockInvitesConfigController from "./controllers/BlockInvitesConfigController.ts";
|
2026-04-09 13:32:50 +01:00
|
|
|
import RequiresSettingsController from "./controllers/RequiresSettingsController.ts";
|
2026-04-17 14:02:42 +02:00
|
|
|
import { type OrderedCustomSections, type CustomSectionsData } from "../stores/room-list-v3/section.ts";
|
2023-03-03 13:31:51 +00:00
|
|
|
|
|
|
|
|
export const defaultWatchManager = new WatchManager();
|
2017-11-03 23:19:45 -06:00
|
|
|
|
|
|
|
|
// These are just a bunch of helper arrays to avoid copy/pasting a bunch of times
|
2020-07-28 12:02:02 -06:00
|
|
|
const LEVELS_ROOM_SETTINGS = [
|
|
|
|
|
SettingLevel.DEVICE,
|
|
|
|
|
SettingLevel.ROOM_DEVICE,
|
|
|
|
|
SettingLevel.ROOM_ACCOUNT,
|
|
|
|
|
SettingLevel.ACCOUNT,
|
|
|
|
|
SettingLevel.CONFIG,
|
|
|
|
|
];
|
|
|
|
|
const LEVELS_ROOM_OR_ACCOUNT = [SettingLevel.ROOM_ACCOUNT, SettingLevel.ACCOUNT];
|
|
|
|
|
const LEVELS_ROOM_SETTINGS_WITH_ROOM = [
|
|
|
|
|
SettingLevel.DEVICE,
|
|
|
|
|
SettingLevel.ROOM_DEVICE,
|
|
|
|
|
SettingLevel.ROOM_ACCOUNT,
|
|
|
|
|
SettingLevel.ACCOUNT,
|
|
|
|
|
SettingLevel.CONFIG,
|
|
|
|
|
SettingLevel.ROOM,
|
|
|
|
|
];
|
|
|
|
|
const LEVELS_ACCOUNT_SETTINGS = [SettingLevel.DEVICE, SettingLevel.ACCOUNT, SettingLevel.CONFIG];
|
|
|
|
|
const LEVELS_DEVICE_ONLY_SETTINGS = [SettingLevel.DEVICE];
|
|
|
|
|
const LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG = [SettingLevel.DEVICE, SettingLevel.CONFIG];
|
2024-06-14 12:00:30 +01:00
|
|
|
const LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED = [SettingLevel.CONFIG, SettingLevel.DEVICE];
|
2020-09-14 22:27:40 -06:00
|
|
|
const LEVELS_UI_FEATURE = [
|
|
|
|
|
SettingLevel.CONFIG,
|
|
|
|
|
// in future we might have a .well-known level or something
|
|
|
|
|
];
|
2017-11-03 23:19:45 -06:00
|
|
|
|
2021-11-25 16:21:10 +00:00
|
|
|
export enum LabGroup {
|
|
|
|
|
Messaging,
|
|
|
|
|
Profile,
|
|
|
|
|
Spaces,
|
|
|
|
|
Widgets,
|
|
|
|
|
Rooms,
|
2024-01-29 18:52:48 +01:00
|
|
|
Threads,
|
2022-09-25 10:57:25 -04:00
|
|
|
VoiceAndVideo,
|
2021-11-25 16:21:10 +00:00
|
|
|
Moderation,
|
|
|
|
|
Themes,
|
|
|
|
|
Encryption,
|
|
|
|
|
Experimental,
|
|
|
|
|
Developer,
|
2024-04-08 10:43:59 +02:00
|
|
|
Ui,
|
2021-11-25 16:21:10 +00:00
|
|
|
}
|
|
|
|
|
|
2022-09-16 11:10:33 +02:00
|
|
|
export enum Features {
|
2023-06-29 17:46:31 +02:00
|
|
|
NotificationSettings2 = "feature_notification_settings2",
|
2022-09-16 11:10:33 +02:00
|
|
|
}
|
|
|
|
|
|
2023-08-22 16:32:05 +01:00
|
|
|
export const labGroupNames: Record<LabGroup, TranslationKey> = {
|
2023-09-08 09:58:31 +01:00
|
|
|
[LabGroup.Messaging]: _td("labs|group_messaging"),
|
|
|
|
|
[LabGroup.Profile]: _td("labs|group_profile"),
|
|
|
|
|
[LabGroup.Spaces]: _td("labs|group_spaces"),
|
|
|
|
|
[LabGroup.Widgets]: _td("labs|group_widgets"),
|
|
|
|
|
[LabGroup.Rooms]: _td("labs|group_rooms"),
|
2024-01-29 18:52:48 +01:00
|
|
|
[LabGroup.Threads]: _td("labs|group_threads"),
|
2023-09-08 09:58:31 +01:00
|
|
|
[LabGroup.VoiceAndVideo]: _td("labs|group_voip"),
|
|
|
|
|
[LabGroup.Moderation]: _td("labs|group_moderation"),
|
|
|
|
|
[LabGroup.Themes]: _td("labs|group_themes"),
|
|
|
|
|
[LabGroup.Encryption]: _td("labs|group_encryption"),
|
|
|
|
|
[LabGroup.Experimental]: _td("labs|group_experimental"),
|
|
|
|
|
[LabGroup.Developer]: _td("labs|group_developer"),
|
2024-04-08 10:43:59 +02:00
|
|
|
[LabGroup.Ui]: _td("labs|group_ui"),
|
2021-11-25 16:21:10 +00:00
|
|
|
};
|
|
|
|
|
|
2024-12-23 20:25:15 +00:00
|
|
|
export type SettingValueType = Json | JsonValue | Record<string, unknown> | Record<string, unknown>[];
|
2022-02-22 11:04:27 +01:00
|
|
|
|
|
|
|
|
export interface IBaseSetting<T extends SettingValueType = SettingValueType> {
|
2021-11-25 16:21:10 +00:00
|
|
|
isFeature?: false | undefined;
|
2020-07-28 12:02:02 -06:00
|
|
|
|
|
|
|
|
// Display names are strongly recommended for clarity.
|
|
|
|
|
// Display name can also be an object for different levels.
|
|
|
|
|
displayName?:
|
2023-08-22 16:32:05 +01:00
|
|
|
| TranslationKey
|
2023-02-13 11:39:16 +00:00
|
|
|
| Partial<{
|
2023-08-22 16:32:05 +01:00
|
|
|
[level in SettingLevel]: TranslationKey;
|
2023-02-13 11:39:16 +00:00
|
|
|
}>;
|
2020-07-28 12:02:02 -06:00
|
|
|
|
2021-06-17 16:22:40 +01:00
|
|
|
// Optional description which will be shown as microCopy under SettingsFlags
|
2023-08-22 16:32:05 +01:00
|
|
|
description?: TranslationKey | (() => ReactNode);
|
2021-06-17 16:22:40 +01:00
|
|
|
|
2020-07-28 12:02:02 -06:00
|
|
|
// The supported levels are required. Preferably, use the preset arrays
|
|
|
|
|
// at the top of this file to define this rather than a custom array.
|
2023-02-28 10:24:59 +00:00
|
|
|
supportedLevels: SettingLevel[];
|
2020-07-28 12:02:02 -06:00
|
|
|
|
|
|
|
|
// Required. Can be any data type. The value specified here should match
|
|
|
|
|
// the data being stored (ie: if a boolean is used, the setting should
|
|
|
|
|
// represent a boolean).
|
2022-02-22 11:04:27 +01:00
|
|
|
default: T;
|
2020-07-28 12:02:02 -06:00
|
|
|
|
|
|
|
|
// Optional settings controller. See SettingsController for more information.
|
2020-07-28 15:24:32 -06:00
|
|
|
controller?: SettingController;
|
2020-07-28 12:02:02 -06:00
|
|
|
|
|
|
|
|
// Optional flag to make supportedLevels be respected as the order to handle
|
|
|
|
|
// settings. The first element is treated as "most preferred". The "default"
|
|
|
|
|
// level is always appended to the end.
|
|
|
|
|
supportedLevelsAreOrdered?: boolean;
|
|
|
|
|
|
|
|
|
|
// Optional value to invert a boolean setting's value. The string given will
|
|
|
|
|
// be read as the setting's ID instead of the one provided as the key for the
|
|
|
|
|
// setting definition. By setting this, the returned value will automatically
|
|
|
|
|
// be inverted, except for when the default value is returned. Inversion will
|
|
|
|
|
// occur after the controller is asked for an override. This should be used by
|
|
|
|
|
// historical settings which we don't want existing user's values be wiped. Do
|
|
|
|
|
// not use this for new settings.
|
|
|
|
|
invertedSettingName?: string;
|
2021-04-27 16:29:42 +01:00
|
|
|
|
2021-07-23 15:47:11 +01:00
|
|
|
// XXX: Keep this around for re-use in future Betas
|
2021-04-27 16:29:42 +01:00
|
|
|
betaInfo?: {
|
2023-08-22 16:32:05 +01:00
|
|
|
title: TranslationKey;
|
2022-02-08 14:02:36 +00:00
|
|
|
caption: () => ReactNode;
|
2022-06-09 13:07:59 -04:00
|
|
|
faq?: (enabled: boolean) => ReactNode;
|
2022-04-05 17:15:31 +01:00
|
|
|
image?: string; // require(...)
|
2023-08-22 16:32:05 +01:00
|
|
|
feedbackSubheading?: TranslationKey;
|
2021-05-11 15:58:19 +01:00
|
|
|
feedbackLabel?: string;
|
2024-12-23 20:25:15 +00:00
|
|
|
extraSettings?: BooleanSettingKey[];
|
2022-02-08 14:02:36 +00:00
|
|
|
requiresRefresh?: boolean;
|
2021-04-27 16:29:42 +01:00
|
|
|
};
|
2022-11-30 22:20:26 +01:00
|
|
|
|
|
|
|
|
// Whether the setting should have a warning sign in the microcopy
|
|
|
|
|
shouldWarn?: boolean;
|
2025-07-02 09:03:31 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Whether the setting should be exported in a rageshake report.
|
|
|
|
|
*/
|
|
|
|
|
shouldExportToRageshake?: boolean;
|
2025-10-09 14:20:53 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Options array for a setting controlled by a dropdown.
|
|
|
|
|
*/
|
|
|
|
|
options?: {
|
|
|
|
|
value: T;
|
|
|
|
|
label: TranslationKey;
|
|
|
|
|
}[];
|
2020-07-28 12:02:02 -06:00
|
|
|
}
|
|
|
|
|
|
2022-02-22 11:04:27 +01:00
|
|
|
export interface IFeature extends Omit<IBaseSetting<boolean>, "isFeature"> {
|
2021-11-25 16:21:10 +00:00
|
|
|
// Must be set to true for features.
|
|
|
|
|
isFeature: true;
|
|
|
|
|
labsGroup: LabGroup;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Type using I-identifier for backwards compatibility from before it became a discriminated union
|
|
|
|
|
export type ISetting = IBaseSetting | IFeature;
|
|
|
|
|
|
2024-12-23 20:25:15 +00:00
|
|
|
export interface Settings {
|
|
|
|
|
[settingName: `UIFeature.${string}`]: IBaseSetting<boolean>;
|
|
|
|
|
|
|
|
|
|
// We can't use the following type because of `feature_sliding_sync_proxy_url` & `feature_hidebold` being in the namespace incorrectly
|
|
|
|
|
// [settingName: `feature_${string}`]: IFeature;
|
|
|
|
|
"feature_video_rooms": IFeature;
|
|
|
|
|
[Features.NotificationSettings2]: IFeature;
|
|
|
|
|
"feature_msc3531_hide_messages_pending_moderation": IFeature;
|
|
|
|
|
"feature_report_to_moderators": IFeature;
|
|
|
|
|
"feature_latex_maths": IFeature;
|
|
|
|
|
"feature_wysiwyg_composer": IFeature;
|
|
|
|
|
"feature_mjolnir": IFeature;
|
|
|
|
|
"feature_custom_themes": IFeature;
|
|
|
|
|
"feature_exclude_insecure_devices": IFeature;
|
2025-07-31 15:20:37 +01:00
|
|
|
"feature_share_history_on_invite": IFeature;
|
2024-12-23 20:25:15 +00:00
|
|
|
"feature_html_topic": IFeature;
|
|
|
|
|
"feature_bridge_state": IFeature;
|
|
|
|
|
"feature_jump_to_date": IFeature;
|
2025-03-18 17:54:32 +00:00
|
|
|
"feature_sliding_sync": IBaseSetting<boolean>;
|
|
|
|
|
"feature_simplified_sliding_sync": IFeature;
|
2024-12-23 20:25:15 +00:00
|
|
|
"feature_element_call_video_rooms": IFeature;
|
|
|
|
|
"feature_group_calls": IFeature;
|
|
|
|
|
"feature_disable_call_per_sender_encryption": IFeature;
|
|
|
|
|
"feature_location_share_live": IFeature;
|
|
|
|
|
"feature_dynamic_room_predecessors": IFeature;
|
|
|
|
|
"feature_render_reaction_images": IFeature;
|
2025-02-12 17:44:18 +05:30
|
|
|
"feature_new_room_list": IFeature;
|
2026-03-31 20:43:32 +02:00
|
|
|
"feature_room_list_sections": IFeature;
|
2024-12-23 20:25:15 +00:00
|
|
|
"feature_ask_to_join": IFeature;
|
|
|
|
|
"feature_notifications": IFeature;
|
2025-12-18 14:45:52 +00:00
|
|
|
"feature_msc4362_encrypted_state_events": IFeature;
|
2024-12-23 20:25:15 +00:00
|
|
|
// These are in the feature namespace but aren't actually features
|
|
|
|
|
"feature_hidebold": IBaseSetting<boolean>;
|
|
|
|
|
|
|
|
|
|
"useOnlyCurrentProfiles": IBaseSetting<boolean>;
|
|
|
|
|
"mjolnirRooms": IBaseSetting<string[]>;
|
|
|
|
|
"mjolnirPersonalRoom": IBaseSetting<string | null>;
|
|
|
|
|
"RoomList.backgroundImage": IBaseSetting<string | null>;
|
|
|
|
|
"sendReadReceipts": IBaseSetting<boolean>;
|
|
|
|
|
"baseFontSize": IBaseSetting<"" | number>;
|
|
|
|
|
"baseFontSizeV2": IBaseSetting<"" | number>;
|
|
|
|
|
"fontSizeDelta": IBaseSetting<number>;
|
|
|
|
|
"useCustomFontSize": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.suggestEmoji": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.showStickersButton": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.showPollsButton": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.insertTrailingColon": IBaseSetting<boolean>;
|
|
|
|
|
"Notifications.alwaysShowBadgeCounts": IBaseSetting<boolean>;
|
|
|
|
|
"Notifications.showbold": IBaseSetting<boolean>;
|
|
|
|
|
"Notifications.tac_only_notifications": IBaseSetting<boolean>;
|
|
|
|
|
"useCompactLayout": IBaseSetting<boolean>;
|
|
|
|
|
"showRedactions": IBaseSetting<boolean>;
|
|
|
|
|
"showJoinLeaves": IBaseSetting<boolean>;
|
|
|
|
|
"showAvatarChanges": IBaseSetting<boolean>;
|
|
|
|
|
"showDisplaynameChanges": IBaseSetting<boolean>;
|
|
|
|
|
"showReadReceipts": IBaseSetting<boolean>;
|
|
|
|
|
"showTwelveHourTimestamps": IBaseSetting<boolean>;
|
|
|
|
|
"alwaysShowTimestamps": IBaseSetting<boolean>;
|
|
|
|
|
"userTimezone": IBaseSetting<string>;
|
|
|
|
|
"userTimezonePublish": IBaseSetting<boolean>;
|
|
|
|
|
"autoplayGifs": IBaseSetting<boolean>;
|
|
|
|
|
"autoplayVideo": IBaseSetting<boolean>;
|
|
|
|
|
"enableSyntaxHighlightLanguageDetection": IBaseSetting<boolean>;
|
|
|
|
|
"expandCodeByDefault": IBaseSetting<boolean>;
|
|
|
|
|
"showCodeLineNumbers": IBaseSetting<boolean>;
|
|
|
|
|
"scrollToBottomOnMessageSent": IBaseSetting<boolean>;
|
|
|
|
|
"Pill.shouldShowPillAvatar": IBaseSetting<boolean>;
|
|
|
|
|
"TextualBody.enableBigEmoji": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.isRichTextEnabled": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposer.showFormatting": IBaseSetting<boolean>;
|
|
|
|
|
"sendTypingNotifications": IBaseSetting<boolean>;
|
|
|
|
|
"showTypingNotifications": IBaseSetting<boolean>;
|
|
|
|
|
"ctrlFForSearch": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.ctrlEnterToSend": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.surroundWith": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.autoReplaceEmoji": IBaseSetting<boolean>;
|
|
|
|
|
"MessageComposerInput.useMarkdown": IBaseSetting<boolean>;
|
|
|
|
|
"VideoView.flipVideoHorizontally": IBaseSetting<boolean>;
|
|
|
|
|
"theme": IBaseSetting<string>;
|
|
|
|
|
"custom_themes": IBaseSetting<CustomTheme[]>;
|
|
|
|
|
"use_system_theme": IBaseSetting<boolean>;
|
|
|
|
|
"useBundledEmojiFont": IBaseSetting<boolean>;
|
|
|
|
|
"useSystemFont": IBaseSetting<boolean>;
|
|
|
|
|
"systemFont": IBaseSetting<string>;
|
|
|
|
|
"webRtcAllowPeerToPeer": IBaseSetting<boolean>;
|
|
|
|
|
"webrtc_audiooutput": IBaseSetting<string>;
|
|
|
|
|
"webrtc_audioinput": IBaseSetting<string>;
|
|
|
|
|
"webrtc_videoinput": IBaseSetting<string>;
|
|
|
|
|
"webrtc_audio_autoGainControl": IBaseSetting<boolean>;
|
|
|
|
|
"webrtc_audio_echoCancellation": IBaseSetting<boolean>;
|
|
|
|
|
"webrtc_audio_noiseSuppression": IBaseSetting<boolean>;
|
|
|
|
|
"language": IBaseSetting<string>;
|
|
|
|
|
"breadcrumb_rooms": IBaseSetting<string[]>;
|
|
|
|
|
"recent_emoji": IBaseSetting<RecentEmojiData>;
|
2025-03-18 14:23:24 +00:00
|
|
|
"showMediaEventIds": IBaseSetting<{ [eventId: string]: boolean }>;
|
2024-12-23 20:25:15 +00:00
|
|
|
"SpotlightSearch.recentSearches": IBaseSetting<string[]>;
|
|
|
|
|
"SpotlightSearch.showNsfwPublicRooms": IBaseSetting<boolean>;
|
|
|
|
|
"room_directory_servers": IBaseSetting<string[]>;
|
|
|
|
|
"integrationProvisioning": IBaseSetting<boolean>;
|
|
|
|
|
"allowedWidgets": IBaseSetting<{ [eventId: string]: boolean }>;
|
|
|
|
|
"analyticsOptIn": IBaseSetting<boolean>;
|
|
|
|
|
"pseudonymousAnalyticsOptIn": IBaseSetting<boolean | null>;
|
|
|
|
|
"deviceClientInformationOptIn": IBaseSetting<boolean>;
|
|
|
|
|
"Registration.mobileRegistrationHelper": IBaseSetting<boolean>;
|
|
|
|
|
"autocompleteDelay": IBaseSetting<number>;
|
|
|
|
|
"readMarkerInViewThresholdMs": IBaseSetting<number>;
|
|
|
|
|
"readMarkerOutOfViewThresholdMs": IBaseSetting<number>;
|
|
|
|
|
"blacklistUnverifiedDevices": IBaseSetting<boolean>;
|
|
|
|
|
"urlPreviewsEnabled": IBaseSetting<boolean>;
|
|
|
|
|
"urlPreviewsEnabled_e2ee": IBaseSetting<boolean>;
|
|
|
|
|
"notificationsEnabled": IBaseSetting<boolean>;
|
|
|
|
|
"deviceNotificationsEnabled": IBaseSetting<boolean>;
|
|
|
|
|
"notificationSound": IBaseSetting<
|
|
|
|
|
| {
|
|
|
|
|
name: string;
|
|
|
|
|
type: string;
|
|
|
|
|
size: number;
|
|
|
|
|
url: string;
|
|
|
|
|
}
|
|
|
|
|
| false
|
|
|
|
|
>;
|
|
|
|
|
"notificationBodyEnabled": IBaseSetting<boolean>;
|
|
|
|
|
"audioNotificationsEnabled": IBaseSetting<boolean>;
|
|
|
|
|
"enableWidgetScreenshots": IBaseSetting<boolean>;
|
|
|
|
|
"promptBeforeInviteUnknownUsers": IBaseSetting<boolean>;
|
|
|
|
|
"widgetOpenIDPermissions": IBaseSetting<{
|
|
|
|
|
allow?: string[];
|
|
|
|
|
deny?: string[];
|
|
|
|
|
}>;
|
|
|
|
|
"breadcrumbs": IBaseSetting<boolean>;
|
|
|
|
|
"showHiddenEventsInTimeline": IBaseSetting<boolean>;
|
2026-04-07 13:16:35 +01:00
|
|
|
/**
|
|
|
|
|
* This is the 2019-era low bandwidth that deals with disabling features of the
|
|
|
|
|
* client. It does NOT make any API or spec changes.
|
|
|
|
|
*/
|
2024-12-23 20:25:15 +00:00
|
|
|
"lowBandwidth": IBaseSetting<boolean>;
|
|
|
|
|
"fallbackICEServerAllowed": IBaseSetting<boolean | null>;
|
2025-03-14 15:11:04 +05:30
|
|
|
"RoomList.preferredSorting": IBaseSetting<SortingAlgorithm>;
|
2026-03-23 19:03:32 +05:30
|
|
|
"RoomList.panelSize": IBaseSetting<number | null>;
|
|
|
|
|
"RoomList.isPanelCollapsed": IBaseSetting<boolean>;
|
2025-03-17 20:37:14 +05:30
|
|
|
"RoomList.showMessagePreview": IBaseSetting<boolean>;
|
2024-12-23 20:25:15 +00:00
|
|
|
"RightPanel.phasesGlobal": IBaseSetting<IRightPanelForRoomStored | null>;
|
|
|
|
|
"RightPanel.phases": IBaseSetting<IRightPanelForRoomStored | null>;
|
|
|
|
|
"enableEventIndexing": IBaseSetting<boolean>;
|
|
|
|
|
"crawlerSleepTime": IBaseSetting<number>;
|
|
|
|
|
"showCallButtonsInComposer": IBaseSetting<boolean>;
|
|
|
|
|
"ircDisplayNameWidth": IBaseSetting<number>;
|
|
|
|
|
"layout": IBaseSetting<Layout>;
|
|
|
|
|
"Images.size": IBaseSetting<ImageSize>;
|
|
|
|
|
"showChatEffects": IBaseSetting<boolean>;
|
|
|
|
|
"Performance.addSendMessageTimingMetadata": IBaseSetting<boolean>;
|
|
|
|
|
"Widgets.pinned": IBaseSetting<{ [widgetId: string]: boolean }>;
|
|
|
|
|
"Widgets.layout": IBaseSetting<ILayoutSettings | null>;
|
|
|
|
|
"Spaces.allRoomsInHome": IBaseSetting<boolean>;
|
|
|
|
|
"Spaces.enabledMetaSpaces": IBaseSetting<Partial<Record<MetaSpace, boolean>>>;
|
|
|
|
|
"Spaces.showPeopleInSpace": IBaseSetting<boolean>;
|
|
|
|
|
"developerMode": IBaseSetting<boolean>;
|
|
|
|
|
"debug_scroll_panel": IBaseSetting<boolean>;
|
|
|
|
|
"debug_timeline_panel": IBaseSetting<boolean>;
|
|
|
|
|
"debug_registration": IBaseSetting<boolean>;
|
|
|
|
|
"debug_animation": IBaseSetting<boolean>;
|
|
|
|
|
"debug_legacy_call_handler": IBaseSetting<boolean>;
|
|
|
|
|
"audioInputMuted": IBaseSetting<boolean>;
|
|
|
|
|
"videoInputMuted": IBaseSetting<boolean>;
|
|
|
|
|
"activeCallRoomIds": IBaseSetting<string[]>;
|
|
|
|
|
"releaseAnnouncementData": IBaseSetting<ReleaseAnnouncementData>;
|
2025-10-09 14:20:53 +01:00
|
|
|
"Electron.autoLaunch": IBaseSetting<"enabled" | "minimised" | "disabled">;
|
2024-12-23 20:25:15 +00:00
|
|
|
"Electron.warnBeforeExit": IBaseSetting<boolean>;
|
|
|
|
|
"Electron.alwaysShowMenuBar": IBaseSetting<boolean>;
|
|
|
|
|
"Electron.showTrayIcon": IBaseSetting<boolean>;
|
|
|
|
|
"Electron.enableHardwareAcceleration": IBaseSetting<boolean>;
|
2025-06-10 08:41:23 +01:00
|
|
|
"Electron.enableContentProtection": IBaseSetting<boolean>;
|
2025-04-22 10:37:47 +01:00
|
|
|
"mediaPreviewConfig": IBaseSetting<MediaPreviewConfig>;
|
2025-06-10 11:47:33 +01:00
|
|
|
"inviteRules": IBaseSetting<ComputedInviteConfig>;
|
2025-11-27 18:42:58 +00:00
|
|
|
"blockInvites": IBaseSetting<boolean>;
|
2025-03-28 20:34:32 +00:00
|
|
|
"Developer.elementCallUrl": IBaseSetting<string>;
|
2026-04-17 14:02:42 +02:00
|
|
|
"RoomList.CustomSectionData": IBaseSetting<CustomSectionsData>;
|
|
|
|
|
"RoomList.OrderedCustomSections": IBaseSetting<OrderedCustomSections>;
|
2024-12-23 20:25:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export type SettingKey = keyof Settings;
|
|
|
|
|
export type FeatureSettingKey = Assignable<Settings, IFeature>;
|
|
|
|
|
export type BooleanSettingKey = Assignable<Settings, IBaseSetting<boolean>> | FeatureSettingKey;
|
2025-03-28 20:34:32 +00:00
|
|
|
export type StringSettingKey = Assignable<Settings, IBaseSetting<string>>;
|
2024-12-23 20:25:15 +00:00
|
|
|
|
|
|
|
|
export const SETTINGS: Settings = {
|
2022-06-09 13:07:59 -04:00
|
|
|
"feature_video_rooms": {
|
|
|
|
|
isFeature: true,
|
2022-09-25 10:57:25 -04:00
|
|
|
labsGroup: LabGroup.VoiceAndVideo,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|video_rooms"),
|
2024-01-11 09:49:00 +00:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2022-06-09 13:07:59 -04:00
|
|
|
default: false,
|
|
|
|
|
// Reload to ensure that the left panel etc. get remounted
|
|
|
|
|
controller: new ReloadOnChangeController(),
|
|
|
|
|
betaInfo: {
|
2023-08-24 11:16:06 +01:00
|
|
|
title: _td("labs|video_rooms"),
|
2022-06-09 13:07:59 -04:00
|
|
|
caption: () => (
|
|
|
|
|
<>
|
|
|
|
|
<p>
|
2023-08-24 11:16:06 +01:00
|
|
|
{_t("labs|video_rooms_a_new_way_to_chat", {
|
2022-06-09 13:07:59 -04:00
|
|
|
brand: SdkConfig.get().brand,
|
|
|
|
|
})}
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
2023-08-24 11:16:06 +01:00
|
|
|
{_t("labs|video_rooms_always_on_voip_channels", {
|
2022-06-09 13:07:59 -04:00
|
|
|
brand: SdkConfig.get().brand,
|
|
|
|
|
})}
|
|
|
|
|
</p>
|
|
|
|
|
</>
|
|
|
|
|
),
|
2026-01-20 12:29:18 +00:00
|
|
|
faq: () => (
|
|
|
|
|
<>
|
|
|
|
|
<h4>{_t("labs|video_rooms_faq1_question")}</h4>
|
|
|
|
|
<p>{_t("labs|video_rooms_faq1_answer")}</p>
|
|
|
|
|
<h4>{_t("labs|video_rooms_faq2_question")}</h4>
|
|
|
|
|
<p>{_t("labs|video_rooms_faq2_answer")}</p>
|
|
|
|
|
</>
|
|
|
|
|
),
|
2022-06-09 13:07:59 -04:00
|
|
|
feedbackLabel: "video-room-feedback",
|
2023-09-19 17:16:38 +01:00
|
|
|
feedbackSubheading: _td("labs|video_rooms_feedbackSubheading"),
|
2024-10-16 16:43:07 +01:00
|
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
2022-06-09 13:07:59 -04:00
|
|
|
image: require("../../res/img/betas/video_rooms.png"),
|
|
|
|
|
requiresRefresh: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
2023-06-29 17:46:31 +02:00
|
|
|
[Features.NotificationSettings2]: {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Experimental,
|
2024-01-11 09:49:00 +00:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|notification_settings"),
|
2023-06-29 17:46:31 +02:00
|
|
|
default: false,
|
|
|
|
|
betaInfo: {
|
2023-09-19 07:17:31 +01:00
|
|
|
title: _td("labs|notification_settings_beta_title"),
|
2023-06-29 17:46:31 +02:00
|
|
|
caption: () => (
|
|
|
|
|
<>
|
|
|
|
|
<p>
|
2023-09-19 17:16:38 +01:00
|
|
|
{_t("labs|notification_settings_beta_caption", {
|
|
|
|
|
brand: SdkConfig.get().brand,
|
|
|
|
|
})}
|
2023-06-29 17:46:31 +02:00
|
|
|
</p>
|
|
|
|
|
</>
|
|
|
|
|
),
|
|
|
|
|
},
|
|
|
|
|
},
|
2022-01-17 16:04:37 +01:00
|
|
|
"feature_msc3531_hide_messages_pending_moderation": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Moderation,
|
2022-04-14 19:23:22 -04:00
|
|
|
// Requires a reload since this setting is cached in EventUtils
|
|
|
|
|
controller: new ReloadOnChangeController(),
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|msc3531_hide_messages_pending_moderation"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2022-01-17 16:04:37 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2025-04-22 10:37:47 +01:00
|
|
|
"mediaPreviewConfig": {
|
|
|
|
|
controller: new MediaPreviewConfigController(),
|
|
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS,
|
|
|
|
|
default: MediaPreviewConfigController.default,
|
|
|
|
|
},
|
2025-06-10 11:47:33 +01:00
|
|
|
"inviteRules": {
|
|
|
|
|
controller: new InviteRulesConfigController(),
|
|
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
|
|
|
|
default: InviteRulesConfigController.default,
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains server names
|
|
|
|
|
shouldExportToRageshake: false,
|
2025-06-10 11:47:33 +01:00
|
|
|
},
|
2025-11-27 18:42:58 +00:00
|
|
|
"blockInvites": {
|
|
|
|
|
controller: new BlockInvitesConfigController("blockInvites"),
|
|
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2021-06-18 18:09:02 +02:00
|
|
|
"feature_report_to_moderators": {
|
|
|
|
|
isFeature: true,
|
2021-11-25 16:21:10 +00:00
|
|
|
labsGroup: LabGroup.Moderation,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|report_to_moderators"),
|
2023-09-19 17:16:38 +01:00
|
|
|
description: _td("labs|report_to_moderators_description"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2021-06-18 18:09:02 +02:00
|
|
|
default: false,
|
|
|
|
|
},
|
2020-10-10 16:32:49 +01:00
|
|
|
"feature_latex_maths": {
|
|
|
|
|
isFeature: true,
|
2021-11-25 16:21:10 +00:00
|
|
|
labsGroup: LabGroup.Messaging,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|latex_maths"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2020-10-10 16:32:49 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2022-10-05 12:01:41 +02:00
|
|
|
"feature_wysiwyg_composer": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Messaging,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|wysiwyg_composer"),
|
|
|
|
|
description: _td("labs|feature_wysiwyg_composer_description"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2022-10-05 12:01:41 +02:00
|
|
|
default: false,
|
|
|
|
|
},
|
2019-10-31 13:19:54 -06:00
|
|
|
"feature_mjolnir": {
|
|
|
|
|
isFeature: true,
|
2021-11-25 16:21:10 +00:00
|
|
|
labsGroup: LabGroup.Moderation,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|mjolnir"),
|
|
|
|
|
description: _td("labs|currently_experimental"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2020-01-02 17:40:18 -07:00
|
|
|
default: false,
|
|
|
|
|
},
|
2020-02-28 11:42:16 -07:00
|
|
|
"feature_custom_themes": {
|
|
|
|
|
isFeature: true,
|
2021-11-25 16:21:10 +00:00
|
|
|
labsGroup: LabGroup.Themes,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|custom_themes"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2020-02-28 11:42:16 -07:00
|
|
|
default: false,
|
|
|
|
|
},
|
2024-09-30 11:29:14 +01:00
|
|
|
"feature_exclude_insecure_devices": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Encryption,
|
|
|
|
|
controller: new DeviceIsolationModeController(),
|
|
|
|
|
displayName: _td("labs|exclude_insecure_devices"),
|
|
|
|
|
description: _td("labs|exclude_insecure_devices_description"),
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2025-07-31 15:20:37 +01:00
|
|
|
"feature_share_history_on_invite": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Encryption,
|
|
|
|
|
displayName: _td("labs|share_history_on_invite"),
|
|
|
|
|
description: () => (
|
|
|
|
|
<>
|
|
|
|
|
{_t("labs|share_history_on_invite_description")}
|
|
|
|
|
<div className="mx_SettingsFlag_microcopy">
|
|
|
|
|
{_t(
|
|
|
|
|
"settings|warning",
|
|
|
|
|
{},
|
|
|
|
|
{
|
|
|
|
|
w: (sub) => <span className="mx_SettingsTab_microcopy_warning">{sub}</span>,
|
|
|
|
|
description: _t("labs|share_history_on_invite_warning"),
|
|
|
|
|
},
|
|
|
|
|
)}
|
|
|
|
|
</div>
|
|
|
|
|
</>
|
|
|
|
|
),
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2026-02-17 12:06:32 +00:00
|
|
|
// Defaulted to true Feb 26, intention is to remove entirely, all being well,
|
|
|
|
|
// as this fixes bugs where display name / avatar are missing and also makes
|
|
|
|
|
// Element Web consistent with Element X.
|
2022-07-04 21:37:48 +02:00
|
|
|
"useOnlyCurrentProfiles": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|disable_historical_profile"),
|
2026-02-17 12:06:32 +00:00
|
|
|
default: true,
|
2022-02-18 07:58:04 -07:00
|
|
|
},
|
2019-10-31 13:19:54 -06:00
|
|
|
"mjolnirRooms": {
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2019-10-31 13:19:54 -06:00
|
|
|
default: [],
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains room IDs
|
|
|
|
|
shouldExportToRageshake: false,
|
2019-10-31 13:19:54 -06:00
|
|
|
},
|
|
|
|
|
"mjolnirPersonalRoom": {
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2019-10-31 13:19:54 -06:00
|
|
|
default: null,
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains room ID
|
|
|
|
|
shouldExportToRageshake: false,
|
2019-10-31 13:19:54 -06:00
|
|
|
},
|
2022-06-07 22:20:32 +02:00
|
|
|
"feature_html_topic": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Rooms,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|html_topic"),
|
2022-06-07 22:20:32 +02:00
|
|
|
default: false,
|
|
|
|
|
},
|
2019-12-09 13:28:43 +00:00
|
|
|
"feature_bridge_state": {
|
|
|
|
|
isFeature: true,
|
2021-11-25 16:21:10 +00:00
|
|
|
labsGroup: LabGroup.Rooms,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|bridge_state"),
|
2019-12-09 13:28:43 +00:00
|
|
|
default: false,
|
|
|
|
|
},
|
2021-12-15 06:34:47 -06:00
|
|
|
"feature_jump_to_date": {
|
2023-03-03 13:31:51 +00:00
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Messaging,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|jump_to_date"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2021-12-15 06:34:47 -06:00
|
|
|
default: false,
|
2023-03-15 08:37:41 +00:00
|
|
|
controller: new ServerSupportUnstableFeatureController(
|
|
|
|
|
"feature_jump_to_date",
|
|
|
|
|
defaultWatchManager,
|
2023-03-17 15:08:17 -05:00
|
|
|
[["org.matrix.msc3030"], ["org.matrix.msc3030.stable"]],
|
2023-03-17 12:31:36 -05:00
|
|
|
"v1.6",
|
2023-08-24 11:16:06 +01:00
|
|
|
_td("labs|jump_to_date_msc_support"),
|
2023-03-15 08:37:41 +00:00
|
|
|
),
|
2021-12-15 06:34:47 -06:00
|
|
|
},
|
2020-07-21 15:02:59 -06:00
|
|
|
"RoomList.backgroundImage": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: null,
|
|
|
|
|
},
|
2022-08-05 17:33:57 +02:00
|
|
|
"sendReadReceipts": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|send_read_receipts"),
|
2022-08-05 17:33:57 +02:00
|
|
|
default: true,
|
2023-03-15 08:37:41 +00:00
|
|
|
controller: new ServerSupportUnstableFeatureController(
|
|
|
|
|
"sendReadReceipts",
|
|
|
|
|
defaultWatchManager,
|
2023-03-17 15:08:17 -05:00
|
|
|
[["org.matrix.msc2285.stable"]],
|
2023-03-15 08:37:41 +00:00
|
|
|
"v1.4",
|
2023-09-19 17:16:38 +01:00
|
|
|
_td("settings|send_read_receipts_unsupported"),
|
2023-03-15 08:37:41 +00:00
|
|
|
true,
|
|
|
|
|
),
|
2021-07-14 15:12:35 +02:00
|
|
|
},
|
2025-03-18 17:54:32 +00:00
|
|
|
// legacy sliding sync flag: no longer works, will error for anyone who's still using it
|
2022-09-07 16:42:39 +01:00
|
|
|
"feature_sliding_sync": {
|
2025-03-18 17:54:32 +00:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
|
|
|
|
shouldWarn: true,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"feature_simplified_sliding_sync": {
|
2022-09-07 16:42:39 +01:00
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Developer,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|sliding_sync"),
|
|
|
|
|
description: _td("labs|sliding_sync_description"),
|
2022-11-30 22:20:26 +01:00
|
|
|
shouldWarn: true,
|
2022-09-07 16:42:39 +01:00
|
|
|
default: false,
|
|
|
|
|
controller: new SlidingSyncController(),
|
|
|
|
|
},
|
2022-09-16 11:12:27 -04:00
|
|
|
"feature_element_call_video_rooms": {
|
|
|
|
|
isFeature: true,
|
2022-09-25 10:57:25 -04:00
|
|
|
labsGroup: LabGroup.VoiceAndVideo,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|element_call_video_rooms"),
|
2022-09-16 11:12:27 -04:00
|
|
|
controller: new ReloadOnChangeController(),
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-09-25 10:57:25 -04:00
|
|
|
"feature_group_calls": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.VoiceAndVideo,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|group_calls"),
|
2022-09-30 15:26:08 -04:00
|
|
|
controller: new ReloadOnChangeController(),
|
2022-09-25 10:57:25 -04:00
|
|
|
default: false,
|
|
|
|
|
},
|
2023-11-10 17:46:02 +01:00
|
|
|
"feature_disable_call_per_sender_encryption": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.VoiceAndVideo,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-11-10 17:46:02 +01:00
|
|
|
displayName: _td("labs|feature_disable_call_per_sender_encryption"),
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-03-07 13:49:32 +01:00
|
|
|
"feature_location_share_live": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Messaging,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|location_share_live"),
|
|
|
|
|
description: _td("labs|location_share_live_description"),
|
2022-11-30 22:20:26 +01:00
|
|
|
shouldWarn: true,
|
2022-03-07 13:49:32 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2023-01-27 14:07:05 +00:00
|
|
|
"feature_dynamic_room_predecessors": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Rooms,
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|dynamic_room_predecessors"),
|
2023-09-19 07:17:31 +01:00
|
|
|
description: _td("labs|dynamic_room_predecessors_description"),
|
2023-01-27 14:07:05 +00:00
|
|
|
shouldWarn: true,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2024-02-21 12:23:07 +01:00
|
|
|
/**
|
|
|
|
|
* @deprecated in favor of {@link fontSizeDelta}
|
|
|
|
|
*/
|
2020-06-04 17:50:56 +01:00
|
|
|
"baseFontSize": {
|
2023-09-08 09:58:31 +01:00
|
|
|
displayName: _td("settings|appearance|font_size"),
|
2020-04-21 11:41:41 +01:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-06-29 11:30:25 +01:00
|
|
|
default: "",
|
|
|
|
|
controller: new FontSizeController(),
|
|
|
|
|
},
|
2023-09-01 04:16:24 -06:00
|
|
|
"feature_render_reaction_images": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Messaging,
|
2023-09-19 07:17:31 +01:00
|
|
|
displayName: _td("labs|render_reaction_images"),
|
|
|
|
|
description: _td("labs|render_reaction_images_description"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-09-01 04:16:24 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
2025-02-12 17:44:18 +05:30
|
|
|
"feature_new_room_list": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
labsGroup: LabGroup.Ui,
|
|
|
|
|
displayName: _td("labs|new_room_list"),
|
|
|
|
|
description: _td("labs|under_active_development"),
|
|
|
|
|
isFeature: true,
|
2025-09-16 09:13:05 +01:00
|
|
|
default: true,
|
2025-02-12 17:44:18 +05:30
|
|
|
controller: new ReloadOnChangeController(),
|
|
|
|
|
},
|
2026-03-31 20:43:32 +02:00
|
|
|
"feature_room_list_sections": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
labsGroup: LabGroup.Ui,
|
|
|
|
|
displayName: _td("labs|room_list_sections"),
|
|
|
|
|
description: _td("labs|under_active_development"),
|
|
|
|
|
isFeature: true,
|
|
|
|
|
default: false,
|
|
|
|
|
controller: new ReloadOnChangeController(),
|
|
|
|
|
},
|
2023-06-29 11:30:25 +01:00
|
|
|
/**
|
|
|
|
|
* With the transition to Compound we are moving to a base font size
|
|
|
|
|
* of 16px. We're taking the opportunity to move away from the `baseFontSize`
|
|
|
|
|
* setting that had a 5px offset.
|
2024-02-21 12:23:07 +01:00
|
|
|
* @deprecated in favor {@link fontSizeDelta}
|
2023-06-29 11:30:25 +01:00
|
|
|
*/
|
|
|
|
|
"baseFontSizeV2": {
|
2023-09-08 09:58:31 +01:00
|
|
|
displayName: _td("settings|appearance|font_size"),
|
2023-06-29 11:30:25 +01:00
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
2024-02-21 12:23:07 +01:00
|
|
|
default: "",
|
|
|
|
|
controller: new FontSizeController(),
|
|
|
|
|
},
|
|
|
|
|
/**
|
|
|
|
|
* This delta is added to the browser default font size
|
|
|
|
|
* Moving from `baseFontSizeV2` to `fontSizeDelta` to replace the default 16px to --cpd-font-size-root (browser default font size) + fontSizeDelta
|
|
|
|
|
*/
|
|
|
|
|
"fontSizeDelta": {
|
|
|
|
|
displayName: _td("settings|appearance|font_size"),
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
default: FontWatcher.DEFAULT_DELTA,
|
2020-04-21 11:41:41 +01:00
|
|
|
controller: new FontSizeController(),
|
|
|
|
|
},
|
2020-04-23 12:09:08 +01:00
|
|
|
"useCustomFontSize": {
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|appearance|custom_font_size"),
|
2020-04-23 12:09:08 +01:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"MessageComposerInput.suggestEmoji": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|emoji_autocomplete"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "MessageComposerInput.dontSuggestEmoji",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2021-01-02 15:31:49 -06:00
|
|
|
"MessageComposerInput.showStickersButton": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_stickers_button"),
|
2021-01-02 15:31:49 -06:00
|
|
|
default: true,
|
2021-12-02 14:09:57 +00:00
|
|
|
controller: new UIFeatureController(UIFeature.Widgets, false),
|
2021-01-02 15:31:49 -06:00
|
|
|
},
|
2022-03-04 11:04:30 -07:00
|
|
|
"MessageComposerInput.showPollsButton": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|show_polls_button"),
|
2022-03-04 11:04:30 -07:00
|
|
|
default: true,
|
|
|
|
|
},
|
2022-03-04 16:13:50 +01:00
|
|
|
"MessageComposerInput.insertTrailingColon": {
|
2022-03-04 08:23:26 +01:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|insert_trailing_colon_mentions"),
|
2022-03-04 08:23:26 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
2020-06-19 15:44:37 -06:00
|
|
|
// TODO: Wire up appropriately to UI (FTUE notifications)
|
|
|
|
|
"Notifications.alwaysShowBadgeCounts": {
|
2020-06-25 08:58:54 +01:00
|
|
|
supportedLevels: LEVELS_ROOM_OR_ACCOUNT,
|
2020-06-19 15:44:37 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
2024-04-12 14:18:09 +01:00
|
|
|
// Used to be a feature, name kept for backwards compat
|
2022-12-06 09:59:17 +00:00
|
|
|
"feature_hidebold": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2023-08-24 11:16:06 +01:00
|
|
|
displayName: _td("labs|hidebold"),
|
2022-12-06 09:59:17 +00:00
|
|
|
default: false,
|
|
|
|
|
},
|
2024-04-12 14:18:09 +01:00
|
|
|
"Notifications.showbold": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
displayName: _td("settings|showbold"),
|
|
|
|
|
default: false,
|
|
|
|
|
invertedSettingName: "feature_hidebold",
|
2024-04-22 17:15:29 +01:00
|
|
|
controller: new AnalyticsController("WebSettingsNotificationsShowBoldToggle"),
|
2024-04-12 14:18:09 +01:00
|
|
|
},
|
|
|
|
|
"Notifications.tac_only_notifications": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
displayName: _td("settings|tac_only_notifications"),
|
|
|
|
|
default: true,
|
2024-04-22 17:15:29 +01:00
|
|
|
controller: new AnalyticsController("WebSettingsNotificationsTACOnlyNotificationsToggle"),
|
2024-04-12 14:18:09 +01:00
|
|
|
},
|
2023-07-10 10:01:03 +02:00
|
|
|
"feature_ask_to_join": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Rooms,
|
2024-01-11 09:49:00 +00:00
|
|
|
default: false,
|
|
|
|
|
displayName: _td("labs|ask_to_join"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-07-10 10:01:03 +02:00
|
|
|
},
|
2023-08-31 21:21:32 +01:00
|
|
|
"feature_notifications": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Messaging,
|
|
|
|
|
displayName: _td("labs|notifications"),
|
2023-09-01 11:00:34 +01:00
|
|
|
description: _td("labs|unrealiable_e2e"),
|
2024-06-14 12:00:30 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2023-08-31 21:21:32 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2025-12-18 14:45:52 +00:00
|
|
|
"feature_msc4362_encrypted_state_events": {
|
|
|
|
|
isFeature: true,
|
|
|
|
|
labsGroup: LabGroup.Encryption,
|
|
|
|
|
displayName: _td("labs|encrypted_state_events"),
|
|
|
|
|
description: _td("labs|encrypted_state_events_description"),
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
|
|
|
|
shouldWarn: true,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"useCompactLayout": {
|
2020-07-03 12:06:00 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|compact_modern"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
2022-12-06 09:59:17 +00:00
|
|
|
controller: new IncompatibleController("layout", false, (v: Layout) => v !== Layout.Group),
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"showRedactions": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_redaction_placeholder"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "hideRedactions",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"showJoinLeaves": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_join_leave"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "hideJoinLeaves",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"showAvatarChanges": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_avatar_changes"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "hideAvatarChanges",
|
2017-11-13 12:58:10 -07:00
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"showDisplaynameChanges": {
|
2017-11-13 12:58:10 -07:00
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_displayname_changes"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "hideDisplaynameChanges",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"showReadReceipts": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_read_receipts"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "hideReadReceipts",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
|
|
|
|
"showTwelveHourTimestamps": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|use_12_hour_format"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"alwaysShowTimestamps": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|always_show_message_timestamps"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
2024-09-02 11:07:07 +02:00
|
|
|
"userTimezone": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
displayName: _td("settings|preferences|user_timezone"),
|
|
|
|
|
default: "",
|
2025-07-02 09:03:31 +01:00
|
|
|
// Location leak
|
|
|
|
|
shouldExportToRageshake: false,
|
2024-09-02 11:07:07 +02:00
|
|
|
},
|
2024-09-12 14:18:25 +01:00
|
|
|
"userTimezonePublish": {
|
|
|
|
|
// This is per-device so you can avoid having devices overwrite each other.
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
displayName: _td("settings|preferences|publish_timezone"),
|
|
|
|
|
default: false,
|
|
|
|
|
controller: new ServerSupportUnstableFeatureController(
|
|
|
|
|
"userTimezonePublish",
|
|
|
|
|
defaultWatchManager,
|
2025-09-02 09:41:49 +01:00
|
|
|
[[UNSTABLE_MSC4133_EXTENDED_PROFILES], [STABLE_MSC4133_EXTENDED_PROFILES]],
|
2024-09-12 14:18:25 +01:00
|
|
|
undefined,
|
|
|
|
|
_td("labs|extended_profiles_msc_support"),
|
|
|
|
|
),
|
|
|
|
|
},
|
2021-09-01 17:28:02 +02:00
|
|
|
"autoplayGifs": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|autoplay_gifs"),
|
2021-09-01 17:28:02 +02:00
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"autoplayVideo": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|autoplay_videos"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"enableSyntaxHighlightLanguageDetection": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|automatic_language_detection_syntax_highlight"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
2021-01-18 17:44:32 +01:00
|
|
|
"expandCodeByDefault": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|code_block_expand_default"),
|
2021-01-18 17:44:32 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2021-01-21 13:08:55 +01:00
|
|
|
"showCodeLineNumbers": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|code_block_line_numbers"),
|
2021-01-21 13:08:55 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
2021-02-26 18:34:54 +01:00
|
|
|
"scrollToBottomOnMessageSent": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|jump_to_bottom_on_send"),
|
2021-02-26 18:34:54 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"Pill.shouldShowPillAvatar": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|show_avatars_pills"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "Pill.shouldHidePillAvatar",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"TextualBody.enableBigEmoji": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|big_emoji"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "TextualBody.disableBigEmoji",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
|
|
|
|
"MessageComposerInput.isRichTextEnabled": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"MessageComposer.showFormatting": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2019-01-24 20:57:40 -07:00
|
|
|
"sendTypingNotifications": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|send_typing_notifications"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "dontSendTypingNotifications",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2020-02-08 21:21:30 +00:00
|
|
|
"showTypingNotifications": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_typing_notifications"),
|
2020-02-08 21:21:30 +00:00
|
|
|
default: true,
|
|
|
|
|
},
|
2021-01-17 16:44:29 +01:00
|
|
|
"ctrlFForSearch": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: IS_MAC ? _td("settings|use_command_f_search") : _td("settings|use_control_f_search"),
|
2021-01-17 16:44:29 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2020-08-30 20:17:08 +12:00
|
|
|
"MessageComposerInput.ctrlEnterToSend": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: IS_MAC
|
|
|
|
|
? _td("settings|use_command_enter_send_message")
|
|
|
|
|
: _td("settings|use_control_enter_send_message"),
|
2020-08-30 20:17:08 +12:00
|
|
|
default: false,
|
|
|
|
|
},
|
2021-02-12 07:53:09 +01:00
|
|
|
"MessageComposerInput.surroundWith": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|surround_text"),
|
2021-02-12 07:53:09 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"MessageComposerInput.autoReplaceEmoji": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|replace_plain_emoji"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
2022-04-19 15:53:59 +02:00
|
|
|
"MessageComposerInput.useMarkdown": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|enable_markdown"),
|
|
|
|
|
description: () => _t("settings|enable_markdown_description", {}, { code: (sub) => <code>{sub}</code> }),
|
2022-04-19 15:53:59 +02:00
|
|
|
default: true,
|
|
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"VideoView.flipVideoHorizontally": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|voip|mirror_local_feed"),
|
2025-06-10 10:27:35 +02:00
|
|
|
default: true,
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
|
|
|
|
"theme": {
|
2019-02-12 09:13:39 +00:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2019-02-13 09:45:20 +00:00
|
|
|
default: "light",
|
2019-02-11 18:10:00 +00:00
|
|
|
controller: new ThemeController(),
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-10-01 15:21:22 +02:00
|
|
|
"custom_themes": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2024-12-23 20:25:15 +00:00
|
|
|
default: [],
|
2025-07-02 09:03:31 +01:00
|
|
|
// Potential privacy leak via theme origin
|
|
|
|
|
shouldExportToRageshake: false,
|
2019-10-01 15:21:22 +02:00
|
|
|
},
|
2019-11-20 13:41:06 +00:00
|
|
|
"use_system_theme": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: true,
|
2023-09-08 09:58:31 +01:00
|
|
|
displayName: _td("settings|appearance|match_system_theme"),
|
2019-11-20 13:41:06 +00:00
|
|
|
},
|
2023-11-23 13:04:05 +00:00
|
|
|
"useBundledEmojiFont": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-11-27 09:59:09 +00:00
|
|
|
default: true,
|
2023-11-23 13:04:05 +00:00
|
|
|
displayName: _td("settings|appearance|bundled_emoji_font"),
|
|
|
|
|
controller: new SystemFontController(),
|
|
|
|
|
},
|
2020-06-15 15:33:52 +01:00
|
|
|
"useSystemFont": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
2023-09-08 09:58:31 +01:00
|
|
|
displayName: _td("settings|appearance|custom_font"),
|
2023-11-23 13:04:05 +00:00
|
|
|
controller: new SystemFontController(),
|
2025-12-04 15:46:21 +00:00
|
|
|
description: () =>
|
|
|
|
|
_t("settings|appearance|custom_font_description", {
|
|
|
|
|
brand: SdkConfig.get().brand,
|
|
|
|
|
}),
|
2020-06-15 15:33:52 +01:00
|
|
|
},
|
|
|
|
|
"systemFont": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: "",
|
2023-09-08 09:58:31 +01:00
|
|
|
displayName: _td("settings|appearance|custom_font_name"),
|
2020-06-15 15:33:52 +01:00
|
|
|
controller: new SystemFontController(),
|
|
|
|
|
},
|
2019-02-13 11:51:32 +00:00
|
|
|
"webRtcAllowPeerToPeer": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|voip|allow_p2p"),
|
|
|
|
|
description: _td("settings|voip|allow_p2p_description"),
|
2019-01-24 20:57:40 -07:00
|
|
|
default: true,
|
|
|
|
|
invertedSettingName: "webRtcForceTURN",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2018-05-26 17:22:23 +01:00
|
|
|
"webrtc_audiooutput": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2022-05-04 16:41:56 +02:00
|
|
|
default: "default",
|
2018-05-26 17:22:23 +01:00
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"webrtc_audioinput": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2022-05-04 16:41:56 +02:00
|
|
|
default: "default",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
|
|
|
|
"webrtc_videoinput": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2022-05-04 16:41:56 +02:00
|
|
|
default: "default",
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2022-11-09 21:14:55 +01:00
|
|
|
"webrtc_audio_autoGainControl": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|voip|auto_gain_control"),
|
2022-11-09 21:14:55 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
"webrtc_audio_echoCancellation": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|voip|echo_cancellation"),
|
2022-11-09 21:14:55 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
"webrtc_audio_noiseSuppression": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|voip|noise_suppression"),
|
2022-11-09 21:14:55 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"language": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2017-11-05 15:37:06 -07:00
|
|
|
default: "en",
|
2025-07-02 09:03:31 +01:00
|
|
|
// For privacy
|
|
|
|
|
shouldExportToRageshake: false,
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2019-04-04 15:06:03 -06:00
|
|
|
"breadcrumb_rooms": {
|
2020-07-16 04:15:32 +01:00
|
|
|
// not really a setting
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2020-07-16 04:15:32 +01:00
|
|
|
default: [],
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains joined rooms
|
|
|
|
|
shouldExportToRageshake: false,
|
2020-07-16 04:15:32 +01:00
|
|
|
},
|
|
|
|
|
"recent_emoji": {
|
|
|
|
|
// not really a setting
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2019-04-04 15:06:03 -06:00
|
|
|
default: [],
|
2025-07-02 09:03:31 +01:00
|
|
|
// For privacy
|
|
|
|
|
shouldExportToRageshake: false,
|
2019-04-04 15:06:03 -06:00
|
|
|
},
|
2021-12-10 11:50:01 +00:00
|
|
|
"SpotlightSearch.recentSearches": {
|
|
|
|
|
// not really a setting
|
|
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
|
|
|
|
default: [], // list of room IDs, most recent first
|
2025-07-02 09:03:31 +01:00
|
|
|
// For privacy
|
|
|
|
|
shouldExportToRageshake: false,
|
2021-12-10 11:50:01 +00:00
|
|
|
},
|
2025-03-18 14:23:24 +00:00
|
|
|
"showMediaEventIds": {
|
|
|
|
|
// not really a setting
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
default: {}, // List of events => is visible
|
2025-07-02 09:03:31 +01:00
|
|
|
// Exports event IDs
|
|
|
|
|
shouldExportToRageshake: false,
|
2025-03-18 14:23:24 +00:00
|
|
|
},
|
2023-02-22 23:23:52 +13:00
|
|
|
"SpotlightSearch.showNsfwPublicRooms": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_nsfw_content"),
|
2023-02-22 23:23:52 +13:00
|
|
|
default: false,
|
|
|
|
|
},
|
2020-03-13 00:02:50 +00:00
|
|
|
"room_directory_servers": {
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2020-03-13 00:02:50 +00:00
|
|
|
default: [],
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains connected servers for user
|
|
|
|
|
shouldExportToRageshake: false,
|
2020-03-13 00:02:50 +00:00
|
|
|
},
|
2019-10-29 14:26:35 -06:00
|
|
|
"integrationProvisioning": {
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2019-10-29 14:20:53 -06:00
|
|
|
default: true,
|
|
|
|
|
},
|
2019-10-29 14:35:35 -06:00
|
|
|
"allowedWidgets": {
|
2021-01-14 17:30:25 +00:00
|
|
|
supportedLevels: [SettingLevel.ROOM_ACCOUNT, SettingLevel.ROOM_DEVICE],
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2019-10-29 14:35:35 -06:00
|
|
|
default: {}, // none allowed
|
2025-07-02 09:03:31 +01:00
|
|
|
shouldExportToRageshake: false,
|
2019-10-29 14:35:35 -06:00
|
|
|
},
|
2022-06-14 17:51:51 +01:00
|
|
|
// Legacy, kept around for transitionary purposes
|
2018-05-15 13:15:40 +01:00
|
|
|
"analyticsOptIn": {
|
2017-11-03 23:19:45 -06:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2021-12-06 09:39:33 +11:00
|
|
|
"pseudonymousAnalyticsOptIn": {
|
|
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|security|send_analytics"),
|
2021-12-06 09:39:33 +11:00
|
|
|
default: null,
|
|
|
|
|
},
|
2022-10-04 09:53:23 +02:00
|
|
|
"deviceClientInformationOptIn": {
|
|
|
|
|
supportedLevels: [SettingLevel.ACCOUNT],
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|security|record_session_details"),
|
2022-10-04 09:53:23 +02:00
|
|
|
default: false,
|
|
|
|
|
},
|
2024-09-13 12:12:04 +01:00
|
|
|
"Registration.mobileRegistrationHelper": {
|
|
|
|
|
supportedLevels: [SettingLevel.CONFIG],
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"autocompleteDelay": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
default: 200,
|
|
|
|
|
},
|
2019-09-17 17:34:30 +01:00
|
|
|
"readMarkerInViewThresholdMs": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
default: 3000,
|
|
|
|
|
},
|
|
|
|
|
"readMarkerOutOfViewThresholdMs": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
default: 30000,
|
|
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
"blacklistUnverifiedDevices": {
|
2017-11-08 17:41:32 -07:00
|
|
|
// We specifically want to have room-device > device so that users may set a device default
|
|
|
|
|
// with a per-room override.
|
2020-07-29 21:00:32 -06:00
|
|
|
supportedLevels: [SettingLevel.ROOM_DEVICE, SettingLevel.DEVICE],
|
2017-11-08 17:41:32 -07:00
|
|
|
supportedLevelsAreOrdered: true,
|
2017-11-04 19:15:55 -07:00
|
|
|
displayName: {
|
2023-09-19 17:16:38 +01:00
|
|
|
"default": _td("settings|security|strict_encryption"),
|
|
|
|
|
"room-device": _td("room_settings|security|strict_encryption"),
|
2017-11-04 19:15:55 -07:00
|
|
|
},
|
2017-11-03 23:19:45 -06:00
|
|
|
default: false,
|
2020-09-18 11:33:02 -06:00
|
|
|
controller: new UIFeatureController(UIFeature.AdvancedEncryption),
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
|
|
|
|
"urlPreviewsEnabled": {
|
2026-04-09 13:32:50 +01:00
|
|
|
// Enabled by default and client configurable as this setting only allows unencrypted
|
|
|
|
|
// messages to be previewed.
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE, SettingLevel.ACCOUNT, SettingLevel.CONFIG],
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
|
|
|
|
displayName: _td("settings|inline_url_previews_default"),
|
2017-11-03 23:19:45 -06:00
|
|
|
default: true,
|
2020-09-14 22:27:40 -06:00
|
|
|
controller: new UIFeatureController(UIFeature.URLPreviews),
|
2017-11-03 23:19:45 -06:00
|
|
|
},
|
2018-06-22 18:44:54 +01:00
|
|
|
"urlPreviewsEnabled_e2ee": {
|
2026-04-09 13:32:50 +01:00
|
|
|
// Can only be enabled per-device to ensure neither the homeserver nor client config
|
|
|
|
|
// can impact the user's choices.
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
|
|
|
|
displayName: _td("settings|inline_url_previews_encrypted"),
|
2018-06-22 18:44:54 +01:00
|
|
|
default: false,
|
2026-04-09 13:32:50 +01:00
|
|
|
controller: new RequiresSettingsController([UIFeature.URLPreviews, "urlPreviewsEnabled"]),
|
2018-06-22 18:44:54 +01:00
|
|
|
},
|
2017-11-04 21:47:18 -07:00
|
|
|
"notificationsEnabled": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
2017-11-04 22:28:35 -07:00
|
|
|
controller: new NotificationsEnabledController(),
|
2025-12-04 15:46:21 +00:00
|
|
|
displayName: _td("settings|notifications|enable_desktop_notifications_session"),
|
2017-11-04 21:47:18 -07:00
|
|
|
},
|
2022-09-28 18:13:09 +01:00
|
|
|
"deviceNotificationsEnabled": {
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
2022-09-30 16:11:04 +01:00
|
|
|
default: true,
|
2025-12-04 15:46:21 +00:00
|
|
|
displayName: _td("settings|notifications|enable_notifications_device"),
|
2022-09-28 18:13:09 +01:00
|
|
|
},
|
2019-04-19 22:31:51 +01:00
|
|
|
"notificationSound": {
|
|
|
|
|
supportedLevels: LEVELS_ROOM_OR_ACCOUNT,
|
|
|
|
|
default: false,
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains personal information in file name
|
|
|
|
|
shouldExportToRageshake: false,
|
2019-04-19 22:31:51 +01:00
|
|
|
},
|
2017-11-04 21:47:18 -07:00
|
|
|
"notificationBodyEnabled": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2017-11-04 22:28:35 -07:00
|
|
|
default: true,
|
|
|
|
|
controller: new NotificationBodyEnabledController(),
|
2025-12-04 15:46:21 +00:00
|
|
|
displayName: _td("settings|notifications|show_message_desktop_notification"),
|
2017-11-04 21:47:18 -07:00
|
|
|
},
|
|
|
|
|
"audioNotificationsEnabled": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2017-11-04 22:28:35 -07:00
|
|
|
default: true,
|
2025-12-04 15:46:21 +00:00
|
|
|
displayName: _td("settings|notifications|enable_audible_notifications_session"),
|
2017-11-04 21:47:18 -07:00
|
|
|
},
|
2018-05-12 14:29:37 -06:00
|
|
|
"enableWidgetScreenshots": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("devtools|widget_screenshots"),
|
2018-05-12 14:29:37 -06:00
|
|
|
default: false,
|
|
|
|
|
},
|
2019-01-16 15:07:30 +00:00
|
|
|
"promptBeforeInviteUnknownUsers": {
|
2019-01-10 21:43:21 -07:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|prompt_invite"),
|
2019-01-16 15:07:30 +00:00
|
|
|
default: true,
|
2019-01-10 21:43:21 -07:00
|
|
|
},
|
2019-03-15 21:33:31 -06:00
|
|
|
"widgetOpenIDPermissions": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: {
|
2019-03-25 21:14:21 -06:00
|
|
|
allow: [],
|
|
|
|
|
deny: [],
|
2019-03-15 21:33:31 -06:00
|
|
|
},
|
2025-07-02 09:03:31 +01:00
|
|
|
// Expses widget information
|
|
|
|
|
shouldExportToRageshake: false,
|
2019-03-15 21:33:31 -06:00
|
|
|
},
|
2019-06-03 00:15:33 -06:00
|
|
|
"breadcrumbs": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_breadcrumbs"),
|
2019-06-03 00:15:33 -06:00
|
|
|
default: true,
|
|
|
|
|
},
|
2019-05-17 17:43:08 +01:00
|
|
|
"showHiddenEventsInTimeline": {
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("devtools|show_hidden_events"),
|
2019-05-17 17:43:08 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2019-02-08 16:44:03 +00:00
|
|
|
"lowBandwidth": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("devtools|low_bandwidth_mode"),
|
|
|
|
|
description: _td("devtools|low_bandwidth_mode_description"),
|
2019-02-08 16:44:03 +00:00
|
|
|
default: false,
|
2019-11-15 11:31:19 +00:00
|
|
|
controller: new ReloadOnChangeController(),
|
2022-11-30 22:20:26 +01:00
|
|
|
shouldWarn: true,
|
2019-02-08 16:44:03 +00:00
|
|
|
},
|
2019-08-14 14:02:25 +01:00
|
|
|
"fallbackICEServerAllowed": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
description: _td("settings|voip|enable_fallback_ice_server_description"),
|
2019-08-14 14:02:25 +01:00
|
|
|
// This is a tri-state value, where `null` means "prompt the user".
|
|
|
|
|
default: null,
|
2024-10-02 15:08:15 +01:00
|
|
|
controller: new FallbackIceServerController(),
|
2019-08-14 14:02:25 +01:00
|
|
|
},
|
2025-03-14 15:11:04 +05:30
|
|
|
"RoomList.preferredSorting": {
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
default: SortingAlgorithm.Recency,
|
|
|
|
|
},
|
2026-03-23 19:03:32 +05:30
|
|
|
"RoomList.panelSize": {
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
default: null,
|
|
|
|
|
},
|
|
|
|
|
"RoomList.isPanelCollapsed": {
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2025-03-17 20:37:14 +05:30
|
|
|
"RoomList.showMessagePreview": {
|
2025-12-04 10:25:50 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
2025-03-17 20:37:14 +05:30
|
|
|
default: false,
|
2025-06-05 16:14:09 +02:00
|
|
|
displayName: _td("settings|show_message_previews"),
|
2025-03-17 20:37:14 +05:30
|
|
|
},
|
2022-01-05 16:14:44 +01:00
|
|
|
"RightPanel.phasesGlobal": {
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
default: null,
|
2019-12-05 15:31:01 -07:00
|
|
|
},
|
2022-01-05 16:14:44 +01:00
|
|
|
"RightPanel.phases": {
|
|
|
|
|
supportedLevels: [SettingLevel.ROOM_DEVICE],
|
|
|
|
|
default: null,
|
2019-12-05 15:31:01 -07:00
|
|
|
},
|
2020-01-23 12:24:54 +01:00
|
|
|
"enableEventIndexing": {
|
2019-11-26 13:31:16 +01:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|security|enable_message_search"),
|
2019-11-26 13:31:16 +01:00
|
|
|
default: true,
|
2019-11-26 15:06:04 +01:00
|
|
|
},
|
2020-01-31 18:44:52 +01:00
|
|
|
"crawlerSleepTime": {
|
2020-01-30 14:18:12 +00:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|security|message_search_sleep_time"),
|
2020-01-31 18:44:52 +01:00
|
|
|
default: 3000,
|
2020-01-30 14:18:12 +00:00
|
|
|
},
|
2020-03-17 11:33:10 +00:00
|
|
|
"showCallButtonsInComposer": {
|
2021-02-26 13:46:39 -07:00
|
|
|
// Dev note: This is no longer "in composer" but is instead "in room header".
|
|
|
|
|
// TODO: Rename with settings v3
|
2020-03-17 11:33:10 +00:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
|
|
|
|
default: true,
|
2020-09-16 13:40:27 +01:00
|
|
|
controller: new UIFeatureController(UIFeature.Voip),
|
2020-03-17 11:33:10 +00:00
|
|
|
},
|
2020-05-13 02:16:43 +01:00
|
|
|
"ircDisplayNameWidth": {
|
|
|
|
|
// We specifically want to have room-device > device so that users may set a device default
|
|
|
|
|
// with a per-room override.
|
2020-07-28 12:02:02 -06:00
|
|
|
supportedLevels: [SettingLevel.ROOM_DEVICE, SettingLevel.DEVICE],
|
|
|
|
|
supportedLevelsAreOrdered: true,
|
2020-05-13 02:16:43 +01:00
|
|
|
default: 80,
|
|
|
|
|
},
|
2021-01-22 13:44:45 +01:00
|
|
|
"layout": {
|
2020-06-16 17:55:19 +01:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2021-01-22 13:44:45 +01:00
|
|
|
default: Layout.Group,
|
2020-06-16 17:55:19 +01:00
|
|
|
},
|
2021-11-17 08:19:30 -07:00
|
|
|
"Images.size": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: ImageSize.Normal,
|
|
|
|
|
},
|
2020-10-19 21:25:01 +02:00
|
|
|
"showChatEffects": {
|
2021-05-20 09:10:21 -06:00
|
|
|
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|show_chat_effects"),
|
2020-10-19 21:25:01 +02:00
|
|
|
default: true,
|
2021-02-17 17:43:31 +00:00
|
|
|
controller: new ReducedMotionController(),
|
2020-10-19 13:24:22 +02:00
|
|
|
},
|
2021-09-08 11:26:54 -06:00
|
|
|
"Performance.addSendMessageTimingMetadata": {
|
|
|
|
|
supportedLevels: [SettingLevel.CONFIG],
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2021-01-18 17:41:42 -07:00
|
|
|
"Widgets.pinned": {
|
|
|
|
|
// deprecated
|
|
|
|
|
supportedLevels: LEVELS_ROOM_OR_ACCOUNT,
|
|
|
|
|
default: {},
|
2025-07-02 09:03:31 +01:00
|
|
|
// Sensitive information in widget ID
|
|
|
|
|
shouldExportToRageshake: false,
|
2021-01-18 17:41:42 -07:00
|
|
|
},
|
|
|
|
|
"Widgets.layout": {
|
2020-09-08 08:48:03 +01:00
|
|
|
supportedLevels: LEVELS_ROOM_OR_ACCOUNT,
|
2020-09-08 16:27:09 +01:00
|
|
|
default: {},
|
2020-09-08 08:48:03 +01:00
|
|
|
},
|
2021-07-30 12:20:02 +01:00
|
|
|
"Spaces.allRoomsInHome": {
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|all_rooms_home"),
|
|
|
|
|
description: _td("settings|all_rooms_home_description"),
|
2021-07-28 14:39:19 +01:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
2021-07-27 21:17:24 +01:00
|
|
|
default: false,
|
2020-09-24 09:28:49 +01:00
|
|
|
},
|
2021-11-11 13:07:41 +00:00
|
|
|
"Spaces.enabledMetaSpaces": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: {
|
|
|
|
|
[MetaSpace.Home]: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
2021-12-17 09:26:32 +00:00
|
|
|
"Spaces.showPeopleInSpace": {
|
|
|
|
|
supportedLevels: [SettingLevel.ROOM_ACCOUNT],
|
|
|
|
|
default: true,
|
2021-08-11 14:52:40 +01:00
|
|
|
},
|
2021-10-20 06:55:22 -06:00
|
|
|
"developerMode": {
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("devtools|developer_mode"),
|
2021-10-20 06:55:22 -06:00
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-05-06 11:13:23 -05:00
|
|
|
"debug_scroll_panel": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"debug_timeline_panel": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-05-20 19:14:17 +02:00
|
|
|
"debug_registration": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-07-29 13:43:29 +02:00
|
|
|
"debug_animation": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-11-30 22:08:09 -06:00
|
|
|
"debug_legacy_call_handler": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-05-16 16:54:08 -04:00
|
|
|
"audioInputMuted": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"videoInputMuted": {
|
|
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
|
|
|
|
default: false,
|
|
|
|
|
},
|
2022-08-30 15:13:39 -04:00
|
|
|
"activeCallRoomIds": {
|
2022-05-16 16:54:08 -04:00
|
|
|
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
2022-08-30 15:13:39 -04:00
|
|
|
default: [],
|
2025-07-02 09:03:31 +01:00
|
|
|
// Contains room IDs
|
|
|
|
|
shouldExportToRageshake: false,
|
2022-05-16 16:54:08 -04:00
|
|
|
},
|
2024-04-08 10:43:59 +02:00
|
|
|
/**
|
|
|
|
|
* Managed by the {@link ReleaseAnnouncementStore}
|
|
|
|
|
* Store the release announcement data
|
|
|
|
|
*/
|
|
|
|
|
"releaseAnnouncementData": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: {},
|
|
|
|
|
},
|
2026-04-17 14:02:42 +02:00
|
|
|
/**
|
|
|
|
|
* Managed by the {@link RoomListStoreV3}
|
|
|
|
|
* Store the custom section data for the room list
|
|
|
|
|
*/
|
|
|
|
|
"RoomList.CustomSectionData": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: {},
|
|
|
|
|
},
|
|
|
|
|
/**
|
|
|
|
|
* Managed by the {@link RoomListStoreV3}
|
|
|
|
|
* Store the ordering of the custom sections for the room list
|
|
|
|
|
*/
|
|
|
|
|
"RoomList.OrderedCustomSections": {
|
|
|
|
|
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
|
|
|
|
default: [],
|
|
|
|
|
},
|
2020-10-27 19:20:25 -06:00
|
|
|
[UIFeature.RoomHistorySettings]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-18 11:33:02 -06:00
|
|
|
[UIFeature.AdvancedEncryption]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-14 22:27:40 -06:00
|
|
|
[UIFeature.URLPreviews]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-16 11:38:50 +01:00
|
|
|
[UIFeature.Widgets]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2023-04-28 08:46:33 +01:00
|
|
|
[UIFeature.LocationSharing]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-16 13:40:27 +01:00
|
|
|
[UIFeature.Voip]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-16 10:59:14 +01:00
|
|
|
[UIFeature.Feedback]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-17 11:55:10 +01:00
|
|
|
[UIFeature.Registration]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
[UIFeature.PasswordReset]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
[UIFeature.Deactivate]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-16 16:06:17 +01:00
|
|
|
[UIFeature.ShareQRCode]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
[UIFeature.ShareSocial]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-16 14:45:34 +01:00
|
|
|
[UIFeature.IdentityServer]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
2021-07-13 15:05:27 +01:00
|
|
|
// Identity server (discovery) settings make no sense if 3PIDs in general are hidden
|
2020-09-18 11:15:48 +01:00
|
|
|
controller: new UIFeatureController(UIFeature.ThirdPartyID),
|
2020-09-16 14:45:34 +01:00
|
|
|
},
|
2020-09-17 13:25:18 +01:00
|
|
|
[UIFeature.ThirdPartyID]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2020-09-16 12:14:33 +01:00
|
|
|
[UIFeature.AdvancedSettings]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
2020-08-18 09:56:38 +02:00
|
|
|
},
|
2021-12-21 10:08:22 +01:00
|
|
|
[UIFeature.TimelineEnableRelativeDates]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
2022-12-02 16:24:45 +13:00
|
|
|
default: true,
|
|
|
|
|
},
|
2025-09-08 14:53:13 +01:00
|
|
|
[UIFeature.AllowCreatingPublicSpaces]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
[UIFeature.AllowCreatingPublicRooms]: {
|
|
|
|
|
supportedLevels: LEVELS_UI_FEATURE,
|
|
|
|
|
default: true,
|
|
|
|
|
},
|
2022-06-10 22:38:50 +01:00
|
|
|
|
|
|
|
|
// Electron-specific settings, they are stored by Electron and set/read over an IPC.
|
|
|
|
|
// We store them over there are they are necessary to know before the renderer process launches.
|
|
|
|
|
"Electron.autoLaunch": {
|
|
|
|
|
supportedLevels: [SettingLevel.PLATFORM],
|
2025-10-09 14:20:53 +01:00
|
|
|
displayName: _td("settings|start_automatically|label"),
|
|
|
|
|
options: [
|
|
|
|
|
{ value: "enabled", label: _td("settings|start_automatically|enabled") },
|
|
|
|
|
{ value: "disabled", label: _td("settings|start_automatically|disabled") },
|
|
|
|
|
{ value: "minimised", label: _td("settings|start_automatically|minimised") },
|
|
|
|
|
],
|
|
|
|
|
default: "disabled",
|
2022-06-10 22:38:50 +01:00
|
|
|
},
|
|
|
|
|
"Electron.warnBeforeExit": {
|
|
|
|
|
supportedLevels: [SettingLevel.PLATFORM],
|
2023-09-01 10:53:32 +01:00
|
|
|
displayName: _td("settings|warn_quit"),
|
2022-06-10 22:38:50 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
"Electron.alwaysShowMenuBar": {
|
|
|
|
|
supportedLevels: [SettingLevel.PLATFORM],
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|always_show_menu_bar"),
|
2022-06-10 22:38:50 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
|
|
|
|
"Electron.showTrayIcon": {
|
|
|
|
|
supportedLevels: [SettingLevel.PLATFORM],
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|enable_tray_icon"),
|
2022-06-10 22:38:50 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
|
|
|
|
"Electron.enableHardwareAcceleration": {
|
|
|
|
|
supportedLevels: [SettingLevel.PLATFORM],
|
2023-09-19 17:16:38 +01:00
|
|
|
displayName: _td("settings|preferences|enable_hardware_acceleration"),
|
2022-06-10 22:38:50 +01:00
|
|
|
default: true,
|
|
|
|
|
},
|
2025-06-10 08:41:23 +01:00
|
|
|
"Electron.enableContentProtection": {
|
|
|
|
|
supportedLevels: [SettingLevel.PLATFORM],
|
2025-06-25 17:24:25 +02:00
|
|
|
displayName: _td("settings|preferences|enable_content_protection"),
|
2025-06-10 08:41:23 +01:00
|
|
|
default: false,
|
|
|
|
|
},
|
2025-03-28 20:34:32 +00:00
|
|
|
"Developer.elementCallUrl": {
|
|
|
|
|
supportedLevels: [SettingLevel.DEVICE],
|
|
|
|
|
displayName: _td("devtools|settings|elementCallUrl"),
|
|
|
|
|
default: "",
|
|
|
|
|
},
|
2017-11-05 15:37:06 -07:00
|
|
|
};
|