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

fixing as requested

Browse source
This commit is contained in:
skuethe 2020-11-06 09:13:24 +01:00 committed by Sebastian Küthe
parent b70550447a
commit d2e779ff5e
2 changed files with 37 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
MMM-pages.js
View file

@ -82,7 +82,7 @@ Module.register('MMM-pages', {
* 'LEAVE_HIDDEN_PAGE' - Hides the currently showing hidden page and resumes showing the last page * '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
*/ */
notificationReceived: function (notification, payload) { notificationReceived: function (notification, payload) {
switch (notification) { switch (notification) {
@ -116,23 +116,23 @@ Module.register('MMM-pages', {
this.sendNotification('PAGE_NUMBER_IS', this.curPage); this.sendNotification('PAGE_NUMBER_IS', this.curPage);
break; break;
case 'PAUSE_ROTATION': case 'PAUSE_ROTATION':
this.pauseRotation(true); this.setRotation(true);
break; break;
case 'RESUME_ROTATION': case 'RESUME_ROTATION':
this.pauseRotation(false); this.setRotation(false);
break; break;
case 'HOME_PAGE': case 'HOME_PAGE':
this.notificationReceived('PAGE_CHANGED', this.config.homePage); this.notificationReceived('PAGE_CHANGED', this.config.homePage);
break; break;
case 'SHOW_HIDDEN_PAGE': case 'SHOW_HIDDEN_PAGE':
Log.log(`[Pages]: received a notification to change to the hidden page "${payload}" of type "${typeof payload}"`); Log.log(`[Pages]: received a notification to change to the hidden page "${payload}" of type "${typeof payload}"`);
this.pauseRotation(true); this.setRotation(true);
this.showHiddenPage(payload); this.showHiddenPage(payload);
break; break;
case 'LEAVE_HIDDEN_PAGE': case 'LEAVE_HIDDEN_PAGE':
Log.log("[Pages]: received a notification to leave the current hidden page "); Log.log("[Pages]: received a notification to leave the current hidden page ");
this.animatePageChange(); this.animatePageChange();
this.pauseRotation(false); this.setRotation(false);
break; break;
default: // Do nothing default: // Do nothing
} }
@ -171,7 +171,7 @@ Module.register('MMM-pages', {
* elements. * elements.
*/ */
updatePages: function () { updatePages: function () {
// Update if there's at least one page. // Update iff there's at least one page.
if (this.config.modules.length !== 0) { if (this.config.modules.length !== 0) {
this.animatePageChange(); this.animatePageChange();
if (!this.rotationPaused) { if (!this.rotationPaused) {
@ -186,50 +186,30 @@ 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;
const modulesToShow = (typeof name !== 'undefined') ? this.config.hiddenPages[name] : this.config.fixed.concat(this.config.modules[this.curPage]);
if (typeof name !== 'undefined') { // Hides all modules not on the current page. This hides any module not
// Hides all modules not defined in the defined named hidden page. // meant to be shown.
MM.getModules()
.exceptWithClass(modulesToShow)
.enumerate(module => module.hide(
self.config.animationTime / 2,
{ lockString: self.identifier }
));
// Shows all modules meant to be on the current page, after a small delay.
setTimeout(() => {
MM.getModules() MM.getModules()
.exceptWithClass(this.config.hiddenPages[name]) .withClass(modulesToShow)
.enumerate(module => module.hide( .enumerate(module => module.show(
self.config.animationTime / 2, self.config.animationTime / 2,
{ lockString: self.identifier } { lockString: self.identifier }
)); ));
// Shows, after a small delay, all modules defined in the selected named hidden page. }, this.config.animationTime / 2);
setTimeout(() => {
MM.getModules()
.withClass(self.config.hiddenPages[name])
.enumerate((module) => {
module.show(
self.config.animationTime / 2,
{ lockString: self.identifier }
);
});
}, this.config.animationTime / 2);
} else {
// Hides all modules not on the current page. This hides any module not
// meant to be shown.
MM.getModules()
.exceptWithClass(this.config.fixed.concat(this.config.modules[this.curPage]))
.enumerate(module => module.hide(
self.config.animationTime / 2,
{ lockString: self.identifier }
));
// Shows all modules meant to be on the current page, after a small delay.
setTimeout(() => {
MM.getModules()
.withClass(self.config.fixed.concat(self.config.modules[self.curPage]))
.enumerate(module => module.show(
self.config.animationTime / 2,
{ lockString: self.identifier }
));
}, this.config.animationTime / 2);
}
}, },
/** /**
@ -274,40 +254,39 @@ Module.register('MMM-pages', {
}, },
/** /**
* Pause or resume the page rotation. If the provided pause 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. "pause" === 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} pause the parameter, if you want to pause or resume. * @param {boolean} isRotating the parameter, if you want to pause or resume.
*/ */
pauseRotation: function (pause) { setRotation: function (isRotating) {
var stateBaseString = (pause) ? "paus" : "resum"; var stateBaseString = (isRotating) ? "paus" : "resum";
if (pause === this.rotationPaused) { if (isRotating === this.rotationPaused) {
Log.warn(`[Pages]: Was asked to ${stateBaseString}e but rotation is already ${stateBaseString}ed!`); Log.warn(`[Pages]: Was asked to ${stateBaseString}e but rotation is already ${stateBaseString}ed!`);
} else { } else {
Log.log(`[Pages]: ${stateBaseString}ing rotation`); Log.log(`[Pages]: ${stateBaseString}ing rotation`);
if (pause) { if (isRotating) {
clearInterval(this.timer); clearInterval(this.timer);
clearInterval(this.delayTimer); clearInterval(this.delayTimer);
} else { } else {
this.resetTimerWithDelay(this.rotationDelay); this.resetTimerWithDelay(this.rotationDelay);
} }
this.rotationPaused = pause; this.rotationPaused = isRotating;
} }
}, },
/** /**
* Handles hidden pages. * Handles hidden pages.
* TODO: this should also interact with "MMM-page-indicator" so that there is no confusion on which page the user currently is
* *
* @param {string} name - the name of the hiddenPage we want to show * @param {string} name the name of the hiddenPage we want to show
*/ */
showHiddenPage: function (name) { showHiddenPage: function (name) {
if (typeof name !== 'undefined') { // Only proceed if the named hidden page actually exists
// Only proceed if the named hidden page actually exists if (name in this.config.hiddenPages) {
if (name in this.config.hiddenPages) { this.animatePageChange(name);
this.animatePageChange(name); } else {
} else { Log.error(`[Pages]: Given name for hidden page ("${name}") does not exist!`); } Log.error(`Hidden page "${name}" does not exist!`);
} }
}, },
}); });

2
readme.md
View file

@ -37,7 +37,7 @@ To display what page you're on, I'd highly recommend checking out my
## Using the module ## Using the module
To use this module, add it to the modules array in the `config/config.js` file. To use this module, add it to the modules array in the `config/config.js` file.
Note: module names used in the following example can be fictitious. Note: module names used in the following example are fictitious.
```js ```js
modules: [ modules: [