2016-04-01 16:43:59 +02:00
|
|
|
# Module: Hello World
|
|
|
|
The `helloworld` module is one of the default modules of the MagicMirror. It is a simple way to display a static text on the mirror.
|
|
|
|
## Using the module
|
|
|
|
|
|
|
|
To use this module, add it to the modules array in the `config/config.js` file:
|
|
|
|
````javascript
|
|
|
|
modules: [
|
|
|
|
{
|
|
|
|
module: 'helloworld',
|
|
|
|
position: 'bottom_bar', // This can be any of the regions.
|
|
|
|
config: {
|
2016-04-03 19:52:13 +02:00
|
|
|
// See 'Configuration options' for more information.
|
2016-04-01 16:43:59 +02:00
|
|
|
text: 'Hello world!',
|
|
|
|
}
|
|
|
|
}
|
|
|
|
]
|
|
|
|
````
|
|
|
|
|
|
|
|
## 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>text</code></td>
|
|
|
|
<td>The text to display.<br>
|
|
|
|
<br><b>Example:</b> <code>'Hello world!'</code>
|
|
|
|
<br><b>Default value:</b> <code>'Hello world!'</code>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
2016-04-03 19:52:13 +02:00
|
|
|
</table>
|