diff --git a/MMM-pages.js b/MMM-pages.js index 092c111..471e815 100644 --- a/MMM-pages.js +++ b/MMM-pages.js @@ -265,7 +265,7 @@ Module.register('MMM-pages', { * @param {boolean} isRotating the parameter, if you want to pause or resume. */ setRotation: function (isRotating) { - var stateBaseString = (isRotating) ? "paus" : "resum"; + const stateBaseString = (isRotating) ? "paus" : "resum"; if (isRotating === this.rotationPaused) { Log.warn(`[Pages]: Was asked to ${stateBaseString}e but rotation is already ${stateBaseString}ed!`); } else { diff --git a/readme.md b/readme.md index 0dfd9c4..95780cb 100644 --- a/readme.md +++ b/readme.md @@ -59,17 +59,18 @@ modules: [ ## Configuration options -| Option | Type | Default Value | Description | -| ------------------- | ------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `modules` | `[[String...]...]` | `[]` | A 2D String array of what each module should be on which page. Note that all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. | -| `fixed` | `[String...]` | `["MMM-page-indicator"]` | Which modules should show up all the time. | -| `excludes` | *NA* | *NA* | **Deprecated**. Use `fixed` instead. | -| `animationTime` | `int` | `1000` | Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). | -| `rotationTime` | `int` | `0` | Time, in milliseconds, between automatic page changes. | -| `rotationDelay` | `int` | `10000` | Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. | -| `rotationHomePage` | `int` | `0` | Time, in milliseconds, before automatically returning to the home page. If a home page is not set, this returns to the leftmost page instead. | -| `rotationFirstPage` | *NA* | *NA* | **Deprecated**. Use `rotationHomePage` instead. | -| `homePage` | `int` | `0` | Which page index is the home page. If none is set, this returns to the leftmost page instead. | +| Option | Type | Default Value | Description | +| ------------------- | ------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `modules` | `[[String...]...]` | `[]` | A 2D String array of what each module should be on which page. Note that all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. | +| `fixed` | `[String...]` | `["MMM-page-indicator"]` | Which modules should show up all the time. | +| `excludes` | *NA* | *NA* | **Deprecated**. Use `fixed` instead. | +| `hiddenPages` | `{String: [String...]...}` | `{}` | An Object defining special `hiddenPages` which are not available on the normal page rotation and only accassible via a notification. Modules defined in `fixed` are ignored and need to be also added if you wish to have them on any hidden page. | +| `animationTime` | `int` | `1000` | Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). | +| `rotationTime` | `int` | `0` | Time, in milliseconds, between automatic page changes. | +| `rotationDelay` | `int` | `10000` | Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. | +| `rotationHomePage` | `int` | `0` | Time, in milliseconds, before automatically returning to the home page. If a home page is not set, this returns to the leftmost page instead. | +| `rotationFirstPage` | *NA* | *NA* | **Deprecated**. Use `rotationHomePage` instead. | +| `homePage` | `int` | `0` | Which page index is the home page. If none is set, this returns to the leftmost page instead. | For the `module` configuration option, the first element of the outer array should consist of elements that should be on the first page. The second element @@ -88,6 +89,8 @@ The following is the list of notifications that MMM-pages will handle: | `PAUSE_ROTATION` | *None* | If MMM-pages is set to rotate, this will pause rotation until a `RESUME_ROTATION` notification is sent. This does nothing if rotation was already paused. | | `RESUME_ROTATION` | *None* | If MMM-pages was requested to pause rotation, this will resume automatic rotation. This does nothing MMM-pages was not requested to pause. | | `HOME_PAGE` | *None* | Return to the home page. If no home page is provided, return to the first page instead. | +| `SHOW_HIDDEN_PAGE` | `String` | MMM-pages will switch to the provided hidden page name. | +| `LEAVE_HIDDEN_PAGE` | *None* | MMM-pages will leave the currently showing hidden page and return to the previous showing page index. | The following is the list of notifications that MMM-pages sends out: