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

Commit

Permalink
document settingDefaults
Browse files Browse the repository at this point in the history
  • Loading branch information
bwindels committed May 31, 2019
1 parent 512c9b2 commit 9e4d8e7
Showing 1 changed file with 11 additions and 0 deletions.
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):
```
{
...
settingDefaults: {
settingName: true
},
...
}
```

### Getting values for a setting

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

0 comments on commit 9e4d8e7

Please sign in to comment.