# Module Configuration
The module configuration is used as part of the main configuration file. Please see configuration for more information.
Option | Description |
---|---|
module | The name of the module. This can also contain the subfolder. Valid examples include clock , default/calendar and custommodules/mymodule . |
position | The location of the module in which the module will be loaded. Possible values are top_bar , top_left , top_center , top_right , upper_third , middle_center , lower_third , bottom_left , bottom_center , bottom_right , bottom_bar , fullscreen_above , and fullscreen_below . This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
classes | A list of additional CSS classes which will be set on the module. This field is optional. |
header | To display a header text above the module, add the header property. This field is optional. |
hiddenOnStartup | Set module as being hidden on startup. This field is optional. |
disabled | Set disabled to true to skip creating the module. This field is optional. |
config | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
# Example
let config = {
modules: [
{
module: "clock",
position: "top_left",
},
{
module: "compliments",
position: "lower_third",
},
{
module: "weather",
position: "top_right",
config: {
weatherProvider: "openweathermap",
type: "current",
location: "New York",
locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
apiKey: "YOUR_OPENWEATHER_API_KEY",
},
},
],
};
# Position
The locations can be found in the following screenshot by their color:
top_bar
andbottom_bar
are light graytop_left
andbottom_left
are redtop_center
andbottom_center
are bluetop_right
andbottom_right
are greenupper_third
is yellowmiddle_center
is cyanlower_third
is magenta
Missing are the fullscreen_below and fullscreen_above as those cover the whole screen, one under everything else and the other above.
All these regions will resize as needed.
← Introduction Alert →