Compare commits

...
Sign in to create a new pull request.

3 commits

Author SHA1 Message Date
Kerry Archibald
1adaabadbc document configurable settings
Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-27 15:04:19 +01:00
Kerry Archibald
c15ded78e8 add max
Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-27 10:10:56 +01:00
Kerry Archibald
6994b7d227 document UIFeature.ForceRoomExportParameters
Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-26 19:20:37 +01:00

View file

@ -93,7 +93,7 @@ For a good example, see https://develop.element.io/config.json.
Defaults to `GB` if the given code is unknown or not provided. Defaults to `GB` if the given code is unknown or not provided.
1. `settingDefaults`: Defaults for settings that support the `config` level, 1. `settingDefaults`: Defaults for settings that support the `config` level,
as an object mapping setting name to value (note that the "theme" setting as an object mapping setting name to value (note that the "theme" setting
is special cased to the `default_theme` in the config file). is special cased to the `default_theme` in the config file). See [Settings section](#settings)
1. `disable_custom_urls`: disallow the user to change the 1. `disable_custom_urls`: disallow the user to change the
default homeserver when signing up or logging in. default homeserver when signing up or logging in.
1. `permalinkPrefix`: Used to change the URL that Element generates permalinks with. 1. `permalinkPrefix`: Used to change the URL that Element generates permalinks with.
@ -200,8 +200,80 @@ Desktop app configuration
See https://github.com/vector-im/element-desktop#user-specified-configjson See https://github.com/vector-im/element-desktop#user-specified-configjson
UI Features # Settings
===========
Defaults for settings that support the `config` level,
as an object mapping setting name to value
*Note* that the "theme" setting is special cased to the `default_theme` in the config file).
## Supported settings
* `alwaysShowTimestamps`: boolean
* `analyticsOptIn`: boolean
* `autocompleteDelay`: number
* `automaticErrorReporting`: boolean
* `autoplayGifs`: boolean
* `autoplayVideo`: boolean
* `baseFontSize`: number
* `breadcrumbs`: boolean
* `ctrlFForSearch`: boolean
* `custom_themes`
* `developerMode`: boolean
* `enableSyntaxHighlightLanguageDetection`: boolean
* `enableWidgetScreenshots`: boolean
* `expandCodeByDefault`: boolean
* `forceRoomExportParameters` - Override room export parameters. Accepts an object:
```
{
range: 'Beginning' | 'Timeline' | 'LastNMessages',
sizeMb: number, // max 100gb
format: 'Html' | 'PlainText' | 'Json',
numberOfMessages: number,
includeAttachments: boolean,
}
```
* `Images.size`: 'normal' | 'large'
* `language`: ISO language code
* `layout`: 'irc' | 'group' | 'bubble'
* `lowBandwidth`: boolean
* `MessageComposerInput.autoReplaceEmoji`: boolean
* `MessageComposerInput.ctrlEnterToSend`: boolean
* `MessageComposerInput.isRichTextEnabled`: boolean
* `MessageComposerInput.showFormatting`: boolean
* `MessageComposerInput.showLocationButton`: boolean
* `MessageComposerInput.showStickersButton`: boolean
* `MessageComposerInput.suggestEmoji`: boolean
* `MessageComposerInput.surroundWith`: boolean
* `Pill.shouldShowPillAvatar`: boolean
* `promptBeforeInviteUnknownUsers`: boolean
* `readMarkerInViewThresholdMs`: number
* `readMarkerOutOfViewThresholdMs`: number
* `RoomList.backgroundImage`
* `scrollToBottomOnMessageSent`: boolean
* `showAvatarChanges`: boolean
* `showCallButtonsInComposer`: boolean
* `showChatEffects`: boolean
* `showCodeLineNumbers`: boolean
* `showCookieBar`: boolean
* `showDeveloperTools`: boolean
* `showDisplaynameChanges`: boolean
* `showImages`: boolean
* `showJoinLeaves`: boolean
* `showReadReceipts`: boolean
* `showRedactions`: boolean
* `showTwelveHourTimestamps`: boolean
* `showTypingNotifications`: boolean
* `Spaces.allRoomsInHome`: boolean
* `TagPanel.enableTagPanel`: boolean
* `TextualBody.enableBigEmoji`: boolean
* `urlPreviewsEnabled`: boolean
* `useCustomFontSize`: number
* `VideoView.flipVideoHorizontally`: boolean
* `webRtcAllowPeerToPeer`: boolean
* `Widgets.leftPanel`
## UI Features
Parts of the UI can be disabled using UI features. These are settings which appear Parts of the UI can be disabled using UI features. These are settings which appear
under `settingDefaults` and can only be `true` (default) or `false`. When `false`, under `settingDefaults` and can only be `true` (default) or `false`. When `false`,