From 9e4d8e7dfee11e151144ac47d4bbc9cbdccba6e0 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Fri, 31 May 2019 15:00:26 +0200 Subject: [PATCH 1/3] document settingDefaults --- docs/settings.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/settings.md b/docs/settings.md index 1ba8981f84..30818625d2 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -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 From 50bb556bc7144b70f6f1ca8060f6e1508640b09d Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Wed, 1 Apr 2020 09:36:50 +0000 Subject: [PATCH 2/3] Update docs/settings.md Co-Authored-By: Travis Ralston --- docs/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings.md b/docs/settings.md index 30818625d2..c22345bc22 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -51,7 +51,7 @@ 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): +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): ``` { ... From ce8f7eaace012a6462a8b45814c93cfb727ec1df Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Wed, 1 Apr 2020 09:37:17 +0000 Subject: [PATCH 3/3] Apply suggestions from code review Co-Authored-By: Travis Ralston --- docs/settings.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/settings.md b/docs/settings.md index c22345bc22..777636359e 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -52,11 +52,11 @@ 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 + "settingDefaults": { + "settingName": true }, ... }