snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/server/settings/README.md

@@ -0,0 +1,58 @@
+## Rocket.Chat main library
+
+This package contains the main libraries of Rocket.Chat.
+
+### APIs
+
+#### Settings
+
+This is an example to create settings:
+```javascript
+settingsRegistry.addGroup('Settings_Group', function() {
+    this.add('SettingInGroup', 'default_value', { type: 'boolean', public: true });
+
+    this.section('Group_Section', function() {
+        this.add('Setting_Inside_Section', 'default_value', {
+            type: 'boolean',
+            public: true,
+            enableQuery: {
+                _id: 'SettingInGroup',
+                value: true
+            }
+        });
+    });
+});
+```
+
+`settingsRegistry.add` type:
+
+* `string` - Stores a string value
+    * Additional options:
+        * `multiline`: boolean
+* `int` - Stores an integer value
+* `boolean` - Stores a boolean value
+* `select` - Creates an `<select>` element
+    * Additional options:
+        * `values`: Array of: { key: 'value', i18nLabel: 'Option_Label' }
+* `color` - Creates a color pick element
+* `action` - Executes a `Method.call` to `value`
+    * Additional options:
+        * `actionText`: Translatable value of the button
+* `asset` - Creates an upload field
+
+`settingsRegistry.add` options:
+
+* `description` - Description of the setting
+* `public` - Boolean to set if the setting should be sent to client or not
+* `enableQuery` - Only enable this setting if the correspondent setting has the value specified
+* `alert` - Shows an alert message with the given text
+
+
+### Functions
+n/a
+
+### Methods
+n/a
+
+### Publications
+n/a