Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

document settingDefaults #3046

Merged
merged 4 commits into from
Apr 1, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
bwindels marked this conversation as resolved.
Show resolved Hide resolved
```
bwindels marked this conversation as resolved.
Show resolved Hide resolved
{
...
settingDefaults: {
bwindels marked this conversation as resolved.
Show resolved Hide resolved
settingName: true
bwindels marked this conversation as resolved.
Show resolved Hide resolved
},
...
}
```

### Getting values for a setting

After importing `SettingsStore`, simply make a call to `SettingsStore.getValue`. The `roomId` parameter should always
Expand Down