kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 11:50:00 +00:00
Code Issues Projects Releases Wiki Activity

Update documentation for compliments module

Browse Source 
Added documentation for the config variable "classes" that allows the user to override the css classes of the compliments module display.

Fixed the erroneous "a default calendar is shown" to "default compliments".
This commit is contained in:
xuanyou 2017-05-18 18:14:43 +08:00 committed by GitHub
parent 5c41e24b99
commit 34361ccd1c
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
modules/default/compliments/README.md
View File

@ -13,7 +13,7 @@ modules: [
// Best results in one of the middle regions like: lower_third
config: {
// The config property is optional.
// If no config is set, an example calendar is shown.
// If no config is set, the default compliments are shown.
// See 'Configuration options' for more information.
}
}
@ -31,6 +31,7 @@ The following properties can be configured:
| `fadeSpeed` | Speed of the update animation. (Milliseconds) <br><br> **Possible values:**`0` - `5000` <br> **Default value:** `4000` (4 seconds)
| `compliments` | The list of compliments. <br><br> **Possible values:** An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. See _compliment configuration_ below. <br> **Default value:** See _compliment configuration_ below.
| `remoteFile` | External file from which to load the compliments <br><br> **Possible values:** Path to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. - `compliments.json` <br> **Default value:** `null` (Do not load from file)
| `classes` | Override the CSS classes of the div showing the compliments
### Compliment configuration