edward/MMM-pages
1
0
Fork 0
mirror of https://github.com/edward-shen/MMM-pages.git synced 2024-11-21 17:54:29 -08:00
Code Issues Projects Releases Packages Wiki Activity

added documentation

Browse source 
typo fixes
This commit is contained in:
Edward Shen 2018-07-30 11:56:12 -04:00
parent 0c33e2f09d
commit 92c4be1973
No known key found for this signature in database
GPG key ID: 4E887A42793D0433
2 changed files with 21 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
MMM-pages.js
View file

@ -85,8 +85,8 @@ Module.register('MMM-pages', {
this.updatePages(true);
this.sendNotification('MAX_PAGES_CHANGED', this.config.modules.length);
break;
case 'REQUEST_CURRENT_PAGE':
this.sendNotification('CURRENT_PAGE_IS', this.curPage);
case 'QUERY_PAGE_NUMBER':
this.sendNotification('PAGE_NUMBER_IS', this.curPage);
break;
default:
}

34
readme.md
View file

@ -50,13 +50,13 @@ modules: [
## Configuration options
Option |Type |Default Value |Description
---------------|------------------|------------------------|-----------
`modules` |`[[String...]...]`|`[]` |A 2D String array of what each module should be on which page. Notethat 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.
`excludes` |`[String...]` |`["MMM-page-indicator"]`|Which modules should show up all the time.
`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.
`delayTime` |`int` |`0` |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.
| Option | Type | Default Value | Description |
| --------------- | ------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `modules` | `[[String...]...]` | `[]` | A 2D String array of what each module should be on which page. Notethat 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. |
| `excludes` | `[String...]` | `["MMM-page-indicator"]` | Which modules should show up all the time. |
| `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. |
| `delayTime` | `int` | `0` | 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. |
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
@ -66,7 +66,7 @@ should consist of elements that should be on the second page, and so forth.
This module responds to the notification `PAGE_CHANGED`. The payload should be
an `integer`. Note that this has strict error checking, so `"3"` will not work,
while `3` will. Also do note that to switch to page 1, you need to send `0` to
while `3` will. Also do note that to switch to page 1, you need to send `0` to
the module. **This uses a zero-based numbering system.**
Let's say that you want to change the indicator to page 3. In your code, you
@ -77,19 +77,23 @@ this.sendNotification("PAGE_CHANGED", 2);
This would cause the module to change show that you are on page 3.
You can also just send `PAGE_INCREMENT` or `PAGE_DECREMENT` without any payloads
(or with, but it will be ignored) to have the module change the displayed page
(or with, but it will be ignored) to have the module change the displayed page
by one.
This module keeps internal track of how many pages you have, defined by your
config in the config file. There is no way to dynamically change the pages you
This module keeps internal track of how many pages you have, defined by your
config in the config file. There is no way to dynamically change the pages you
have. If there arises a need, please create an issue.
This module sends one notification, `MAX_PAGES_CHANGED` to assist display
modules with how many pages they should display. However, this module does not
enforce what page other modules should indicate. This is intentional, because
any other module that needs a page change notification should be recieving from
This module sends one notification, `MAX_PAGES_CHANGED` to assist display
modules with how many pages they should display. However, this module does not
enforce what page other modules should indicate. This is intentional, because
any other module that needs a page change notification should be receiving from
the notification system.
Finally, if you want to know what page you're currently on, send a `QUERY_PAGE_NUMBER`
notification. The module will respond with a `PAGE_NUMBER_IS` notification,
with the payload of the current page number.
## FAQ
- Help! My module is (above/below) another module in the same region but I want