mirror of
https://github.com/the-djmaze/snappymail.git
synced 2024-12-29 11:01:34 +08:00
Improved plugin documentation
This commit is contained in:
parent
6d6690009c
commit
92cec80b73
2 changed files with 22 additions and 6 deletions
|
@ -60,7 +60,7 @@ export class AbstractViewPopup extends AbstractView
|
|||
this.keyScope.scope = name;
|
||||
this.modalVisible = ko.observable(false).extend({ rateLimit: 0 });
|
||||
shortcuts.add('escape,close', '', name, () => {
|
||||
if (this.modalVisible() && this.onClose()) {
|
||||
if (this.modalVisible() && false !== this.onClose()) {
|
||||
this.closeCommand();
|
||||
return false;
|
||||
}
|
||||
|
@ -70,14 +70,13 @@ export class AbstractViewPopup extends AbstractView
|
|||
}
|
||||
|
||||
// Happens when user hits Escape or Close key
|
||||
onClose() {
|
||||
return true; // false to prevent closing
|
||||
}
|
||||
// return false to prevent closing
|
||||
onClose() {}
|
||||
|
||||
/*
|
||||
onBeforeShow() {} // Happens before showModal()
|
||||
onShow() {} // Happens after showModal()
|
||||
afterShow() {} // Happens after showModal() animation transitionend
|
||||
onShow() {} // Happens after showModal()
|
||||
afterShow() {} // Happens after showModal() animation transitionend
|
||||
onHide() {} // Happens before animation transitionend
|
||||
afterHide() {} // Happens after animation transitionend
|
||||
|
||||
|
|
|
@ -17,6 +17,23 @@ JavaScript
|
|||
```javascript
|
||||
class PluginPopupView extends rl.pluginPopupView
|
||||
{
|
||||
// Happens when DOM is created
|
||||
onBuild(dom) {}
|
||||
|
||||
// Happens before showModal()
|
||||
onBeforeShow(...params) {}
|
||||
// Happens after showModal()
|
||||
onShow(...params) {}
|
||||
// Happens after showModal() animation transitionend
|
||||
afterShow() {}
|
||||
|
||||
// Happens when user hits Escape or Close key
|
||||
// return false to prevent closing, use closeCommand() manually
|
||||
onClose() {}
|
||||
// Happens before animation transitionend
|
||||
onHide() {}
|
||||
// Happens after animation transitionend
|
||||
afterHide() {}
|
||||
}
|
||||
|
||||
PluginPopupView.showModal();
|
||||
|
|
Loading…
Reference in a new issue