https://github.com/barnabycolby/MMM-Carousel

Displays a single magic mirror module at a time, rotating through the list of configured modules in a carousel-like fashion.
https://github.com/barnabycolby/MMM-Carousel

Last synced: 7 months ago
JSON representation

Displays a single magic mirror module at a time, rotating through the list of configured modules in a carousel-like fashion.

Host: GitHub
URL: https://github.com/barnabycolby/MMM-Carousel
Owner: barnabycolby
Created: 2016-08-16T20:28:36.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2024-03-25T23:37:56.000Z (about 2 years ago)
Last Synced: 2024-06-29T10:33:38.973Z (almost 2 years ago)
Language: JavaScript
Size: 12.7 KB
Stars: 98
Watchers: 15
Forks: 33
Open Issues: 19
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-mmm - **MMM-Carousel**

README

# MMM-Carousel
> This is an extension to the [MagicMirror](https://github.com/MichMich/MagicMirror) project, allowing the modules to be displayed in a rotating carousel instead of displaying all of them at once. There are three modes available:
* `'global'` - All modules not cited in the `ignoreModules` config are rotated, displaying only one at a time for the duration of `transitionInterval`. This is particularly useful on small screens where there may not be enough space to display several components at once.
* `'positional'` - Modules are grouped by `position` setting and rotated within a position except for modules listed in that position's `ignoreModules`, an `overrideTransitionInterval` can also be set to rotated different position at different speeds.
* `'slides'` - groups of modules can be assigned to be displayed at the same time (regardless of `position`), an unlimited number of these "slide" groups can be set up.

[![Build Status](https://travis-ci.org/barnabycolby/MMM-Carousel.svg?branch=master)](https://travis-ci.org/barnabycolby/MMM-Carousel)

## Installation
Run these commands at the root of your magic mirror install.

```shell
cd modules
git clone https://github.com/barnabycolby/MMM-Carousel
```

## Using the module
To use this module, add the following configuration block to the modules array in the `config/config.js` file:
```js
var config = {
modules: [
{
module: 'MMM-Carousel',
config: {
// See below for configurable options
}
}
]
}
```

Note that a `position` setting is not required.

### Configuration options
The following properties can be configured:

Option
Description

mode

'global' - All modules not cited in the ignoreModules config are rotated, displaying only one at a time for the duration of transitionInterval. This is particularly useful on small screens where there may not be enough space to display several components at once.

'positional' - Modules are grouped by position setting and rotated within a position except for modules listed in that position's ignoreModules, an overrideTransitionInterval can also be set to rotated different position at different speeds.

'slides' - groups of modules can be assigned to be displayed at the same time (regardless of position), an unlimited number of these "slide" groups can be set up.

This value is OPTIONAL

Possible values: 'global' or 'positional' or 'slides'

Default value: 'global'

transitionInterval
The number of milliseconds to display each module for.

This value is OPTIONAL

Possible values: Any valid int

Default value: 10000

ignoreModules
A list of module names whom should not be considered as part of the carousel. For example, the `alert` module should be able to display a notification at any time, by ignoring it we can prevent the plugin from hiding any notifications. NOTE: is only used in 'global' and 'slides' modes. Ignored modules in 'slides' mode are shown on every slide..

This value is OPTIONAL

Possible values: String array

Default value: []

top_bar

top_left

top_center

top_right

upper_third

middle_center

lower_third

bottom_left

bottom_center

bottom_right

bottom_bar

Determines if this position should be rotated and which modules in this position should be ignored. NOTE: is only used when mode is 'positional' otherwise ignored.

This value is OPTIONAL

Possible values: Object with keys;

         enabled, a boolean to rotate this position or not,

         ignoredModules, a String array of modules names to ignore.

         overrideTransitionInterval, a int a transition time for this position only.

Default value: {enabled: false, ignoreModules: [], overrideTransitionInterval: 10000}

slides
An array of string arrays. Each string array is a list of content for an individual slide. The slides will be rotated as a complete set using the transitionInterval setting. Ingnored modules (ignoreModules) will be diplayed on all slides.

This value is OPTIONAL

Possible values: array of String array

Default value: [[]]

#### Example - Global Carousel
```javascript
var config = {
modules: [
{
module: 'MMM-Carousel',
config: {
transitionInterval: 10000,
ignoreModules: ['clock'],
mode: 'global'
}
}
]
}
```
#### Example - Positional Carousel
```javascript
var config = {
modules: [
{
module: 'MMM-Carousel',
config: {
transitionInterval: 10000,
ignoreModules: [],
mode: 'positional',
top_left: {enabled: true, ignoreModules: [], overrideTransitionInterval: 15000},
top_right: {enabled: true, ignoreModules: ['currentweather']}
}
}
]
}
```
#### Example - Slides Carousel
```javascript
var config = {
modules: [
{
module: 'MMM-Carousel',
config: {
transitionInterval: 10000,
ignoreModules: ['clock', 'alert'],
mode: 'slides',
slides: [
['calendar', 'compliments', 'currentweather'],
['weatherforecast', 'MMM-Trello', 'planetrise', 'newsfeed'],
['MMM-fitbit']
]
}
}
]
}
```

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/barnabycolby/MMM-Carousel

Awesome Lists containing this project

README