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

Merge pull request #3046 from matrix-org/bwindels/settings-config-doc

Browse source 
document settingDefaults
This commit is contained in:
Bruno Windels 2020-04-01 09:57:43 +00:00 committed by GitHub
commit 775ba0f74e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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 some settings, like the "theme" setting, are special cased in the config file):
```json
{
...
"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