PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

document settingDefaults

Browse source
This commit is contained in:
Bruno Windels 2019-05-31 15:00:26 +02:00
parent 512c9b2ac8
commit 9e4d8e7dfe
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/settings.md
View file

@ -51,6 +51,17 @@ Settings are the different options a user may set or experience in the applicati
} }
``` ```
Settings that support the config level can be set in the config file under the `settingDefaults` key (note that the "theme" setting is special cased to the `default_theme` in the config file):
```
{
...
settingDefaults: {
settingName: true
},
...
}
```
### Getting values for a setting ### Getting values for a setting
After importing `SettingsStore`, simply make a call to `SettingsStore.getValue`. The `roomId` parameter should always After importing `SettingsStore`, simply make a call to `SettingsStore.getValue`. The `roomId` parameter should always