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

trying to limit to 80 characters

Browse source
This commit is contained in:
skuethe 2020-11-06 09:42:31 +01:00 committed by Sebastian Küthe
parent d2e779ff5e
commit e07a2f3b1b
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
MMM-pages.js
View file

@ -78,8 +78,10 @@ Module.register('MMM-pages', {
* 'PAUSE_ROTATION' - Stops rotation * 'PAUSE_ROTATION' - Stops rotation
* 'RESUME_ROTATION' - Resumes rotation * 'RESUME_ROTATION' - Resumes rotation
* 'HOME_PAGE' - Calls PAGED_CHANGED with the default home page. * 'HOME_PAGE' - Calls PAGED_CHANGED with the default home page.
* 'SHOW_HIDDEN_PAGE' - Shows the (in the payload) specified hidden page by name * 'SHOW_HIDDEN_PAGE' - Shows the (in the payload) specified hidden
* 'LEAVE_HIDDEN_PAGE' - Hides the currently showing hidden page and resumes showing the last page * page by name
* 'LEAVE_HIDDEN_PAGE' - Hides the currently showing hidden page and
* resumes showing the last page
* *
* @param {string} notification the notification ID * @param {string} notification the notification ID
* @param {number|string} payload the page to change to/by * @param {number|string} payload the page to change to/by
@ -186,7 +188,8 @@ Module.register('MMM-pages', {
* assumes that there is a discrepancy between the page currently being shown * assumes that there is a discrepancy between the page currently being shown
* and the page that is meant to be shown. * and the page that is meant to be shown.
* *
* @param {string} [name] the name of the hiddenPage we want to show. Optional and only used when we want to switch to a hidden page * @param {string} [name] the name of the hiddenPage we want to show.
* Optional and only used when we want to switch to a hidden page
*/ */
animatePageChange: function (name) { animatePageChange: function (name) {
const self = this; const self = this;
@ -256,7 +259,8 @@ Module.register('MMM-pages', {
/** /**
* Pause or resume the page rotation. If the provided isRotating value is * Pause or resume the page rotation. If the provided isRotating value is
* set to false, it will resume the rotation. If the requested * set to false, it will resume the rotation. If the requested
* state (f.e. isRotating === true) equals the current state, print a warning and do nothing. * state (f.e. isRotating === true) equals the current state, print a warning
* and do nothing.
* *
* @param {boolean} isRotating the parameter, if you want to pause or resume. * @param {boolean} isRotating the parameter, if you want to pause or resume.
*/ */