mirrors/element-web
1
0
Fork 0
mirror of https://github.com/element-hq/element-web synced 2024-10-24 11:45:50 +03:00
Code Issues Projects Releases Packages Wiki Activity

Improve documentation of settings

Browse source 
Signed-off-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Travis Ralston 2017-11-04 15:44:01 -06:00
parent 8282534f87
commit 257e1aabb8
1 changed files with 18 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/settings/Settings.js
View file

@ -28,13 +28,21 @@ const LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG = ['device', 'config'];
export const SETTINGS = { export const SETTINGS = {
// EXAMPLE SETTING: // EXAMPLE SETTING:
// "my-setting": { // "my-setting": {
// // Required by features, optional otherwise // // Must be set to true for features. Default is 'false'.
// isFeature: false, // isFeature: false,
// //
// // Recommended. // // Display names are strongly recommended for clarity.
// displayName: _td("Cool Name"), // displayName: _td("Cool Name"),
// //
// // Required. // // Display name can also be an object for different levels.
// //displayName: {
// // "device": _td("Name for when the setting is used at 'device'"),
// // "room": _td("Name for when the setting is used at 'room'"),
// // "default": _td("The name for all other levels"),
// //}
//
// // The supported levels are required. Preferably, use the preset arrays
// // at the top of this file to define this rather than a custom array.
// supportedLevels: [ // supportedLevels: [
// // The order does not matter. // // The order does not matter.
// //
@ -48,7 +56,9 @@ export const SETTINGS = {
// // "default" is always supported and does not get listed here. // // "default" is always supported and does not get listed here.
// ], // ],
// //
// // Optional. Any data type. // // 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).
// default: { // default: {
// your: "value", // your: "value",
// }, // },
@ -57,11 +67,13 @@ export const SETTINGS = {
isFeature: true, isFeature: true,
displayName: _td("Communities"), displayName: _td("Communities"),
supportedLevels: LEVELS_FEATURE, supportedLevels: LEVELS_FEATURE,
default: false,
}, },
"feature_pinning": { "feature_pinning": {
isFeature: true, isFeature: true,
displayName: _td("Message Pinning"), displayName: _td("Message Pinning"),
supportedLevels: LEVELS_FEATURE, supportedLevels: LEVELS_FEATURE,
default: false,
}, },
"MessageComposerInput.dontSuggestEmoji": { "MessageComposerInput.dontSuggestEmoji": {
supportedLevels: LEVELS_ACCOUNT_SETTINGS, supportedLevels: LEVELS_ACCOUNT_SETTINGS,
@ -157,9 +169,11 @@ export const SETTINGS = {
}, },
"webrtc_audioinput": { "webrtc_audioinput": {
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS, supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
default: null,
}, },
"webrtc_videoinput": { "webrtc_videoinput": {
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS, supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
default: null,
}, },
"language": { "language": {
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG, supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,