Add plugin settings usage example

cerebroapp · Apr 12, 2017 · 3c7a5ac · 3c7a5ac
1 parent 71d732a
commit 3c7a5ac
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/docs/plugins/examples.md b/docs/plugins/examples.md
@@ -141,3 +141,33 @@ module.exports = {
   fn: plugin
 };
 ```
+
+### using `settings`
+```js
+const plugin = ({ display, settings }) => {
+  const icon = require('[path-to-icon]/icon.png');
+
+  display({
+    icon: settings.icon ? icon : '',
+    title: `${settings.username}, you have been around for ${settings.age}`,
+    subtitle: `Favorite languages: ${settings.languages.join(',')}`,
+  })
+}
+
+module.exports = {
+  fn: plugin,
+  settings: {
+    username: { type: 'string' },
+    age: { type: 'number', defaultValue: 42 },
+    icon: { type: 'bool' },
+    languages: {
+      type: 'option',
+      description: 'Your favorite programming languages'
+      options: ['JavaScript', 'Haskell', 'Rust'],
+      multi: true,
+      createable: true,
+    }
+  }
+}
+
+```