kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-08-23 13:24:06 +00:00
Code Issues Projects Releases Wiki Activity

Add getHeader functionlity..

Browse Source
This commit is contained in:
Michael Teeuw
2016-09-20 17:22:24 +02:00
parent c916472b22
commit b2a7d3584b
4 changed files with 66 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
modules/README.md
View File

@@ -166,6 +166,23 @@ getDom: function() {
````
####`getHeader()`
**Should return:** String
Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getHeader method to retrieve the module's header. This method should therefor return a string. If this method is not subclassed, this function will return the user's configured header.
If you want to use the original user's configured header, reference `this.data.header`.
**NOTE:** If the user did not confiugure a default header, no header will be displayed and thus this method will not be called.
**Example:**
````javascript
getHeader: function() {
return this.data.header + ' Foo Bar';
}
````
####`notificationReceived(notification, payload, sender)`
That MagicMirror core has the ability to send notifications to modules. Or even better: the modules have the possibility to send notifications to other modules. When this module is called, it has 3 arguments: