From becf029583ebb64722acbac9d1e0bba985884b13 Mon Sep 17 00:00:00 2001 From: Michael Teeuw Date: Sat, 9 Apr 2016 17:58:10 +0200 Subject: [PATCH] Add header info. --- README.md | 6 ++++++ modules/README.md | 11 +++++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 569895fe..aa9a977b 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,12 @@ Module configuration:
Note: This field is optional. + + header + To display a header above the module, add the header property. (String) +
Note: This field is optional. + + config An object with the module configuration properties. Check the documentation of the module for more info.
diff --git a/modules/README.md b/modules/README.md index 0ad2044d..97f973ff 100644 --- a/modules/README.md +++ b/modules/README.md @@ -64,6 +64,17 @@ This represents if the module is currently hidden (faded away). The configuration of the module instance as set in the user's config.js file. This config will also contain the module's defaults if these properties are not over written by the user config. +####`this.config` +**Boolean** + +The data object contains additional metadata about the module instance: +- `data.classes` - The classes which are added to the module dom wrapper. +- `data.file` - The filename of the core module file. +- `data.path` - The path of the module folder. +- `data.header` - The header added to the module. +- `data.position` - The position in which the instance will be shown. + + ####`defaults: {}` Any properties defined in the defaults object, will be merged with the module config as defined in the user's config.js file. This is the best place to set your modules's configuration defaults. Any of the module configuration properties can be accessed using `this.config.propertyName`, but more about that later.