mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-28 20:22:53 +00:00
5eed80c28e
commit e38dd346d9f796807ea71035c18e3533ec245ba6
Author: Michael Teeuw <michael@xonaymedia.nl>
Date: Sat Apr 2 19:17:30 2016 +0200
Add the possibility to set the maximum number of days.
commit 6f5c86775b708d19d3798267ffd23e491a1d2c62
Author: Sam Vendittelli <sam.vendittelli@hotmail.com>
Date: Sat Apr 2 06:27:44 2016 +0100
Fixed cursor appearing in margin
Cursor was appearing in the margin so moved `cursor: none` property to html.
commit 576c668d84b34b8ad7a0fd51b146fde60f721682
Author: Domi-G <lessuseguy+githubdomig@gmail.com>
Date: Fri Apr 1 22:52:32 2016 +0200
Huge cleanup of white space
88 lines
2.3 KiB
Markdown
88 lines
2.3 KiB
Markdown
# Module: Compliments
|
|
The `compliments` module is one of the default modules of the MagicMirror.
|
|
This module displays a random compliment.
|
|
|
|
## Using the module
|
|
|
|
To use this module, add it to the modules array in the `config/config.js` file:
|
|
````javascript
|
|
modules: [
|
|
{
|
|
module: 'compliments',
|
|
position: 'lower_third', // This can be any of the regions.
|
|
// 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.
|
|
// See 'Configuration options' for more information.
|
|
}
|
|
}
|
|
]
|
|
````
|
|
|
|
## Configuration options
|
|
|
|
The following properties can be configured:
|
|
|
|
|
|
<table width="100%">
|
|
<!-- why, markdown... -->
|
|
<thead>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th width="100%">Description</th>
|
|
</tr>
|
|
<thead>
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td><code>updateInterval</code></td>
|
|
<td>How often does the compliment have to change? (Milliseconds)<br>
|
|
<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
|
|
<br><b>Default value:</b> <code>30000</code> (30 seconds)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fadeSpeed</code></td>
|
|
<td>Speed of the update animation. (Milliseconds)<br>
|
|
<br><b>Possible values:</b><code>0</code> - <code>5000</code>
|
|
<br><b>Default value:</b> <code>4000</code> (4 seconds)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>compliments</code></td>
|
|
<td>The list of compliments.<br>
|
|
<br><b>Possible values:</b> An object with three arrays: <code>morning</code>, <code>afternoon</code> and<code>evening</code>. See <i>compliment configuration</i> below.
|
|
<br><b>Default value:</b> See <i>compliment configuration</i> below.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
### Compliment configuration
|
|
|
|
The `compliments` property contains an object with three arrays: <code>morning</code>, <code>afternoon</code> and<code>evening</code>. Based on the time of the day, the compliments will be picked out of one of these arrays. The arrays contain one or multiple compliments.
|
|
|
|
#### Default value:
|
|
````javascript
|
|
config: {
|
|
compliments: {
|
|
morning: [
|
|
'Good morning, handsome!',
|
|
'Enjoy your day!',
|
|
'How was your sleep?'
|
|
],
|
|
afternoon: [
|
|
'Hello, beauty!',
|
|
'You look sexy!',
|
|
'Looking good today!'
|
|
],
|
|
evening: [
|
|
'Wow, you look hot!',
|
|
'You look nice!',
|
|
'Hi, sexy!'
|
|
]
|
|
}
|
|
}
|
|
````
|