@blackcube/aurelia-kit 1.0.0-rc6 → 1.0.0-rc7

package/dist/types/attributes/menu.d.ts

@@ -1,12 +1,16 @@
 import { IEventAggregator, ILogger, IPlatform } from "aurelia";
 import { ITransitionService } from '../services/transition-service';
 import { IStorageService } from '../services/storage-service';
+import { ITrapFocusService } from '../services/trap-focus-service';
 /**
  * Side menu rendered by the PHP Sidebar widget: opened and closed through Channels.Menu with
  * the data-menu-show / data-menu-hide classes of the element; [data-menu=toggle-button-ID]
  * shows or hides [data-menu=toggle-list-ID] (hidden attribute, accordion: opening one closes the others) and sets
  * the data-menu-show / data-menu-hide classes of its svg[data-menu=icon]. The open sublists are kept in storage; a
  * button added after attaching is linked on its first click.
+ * Open, the focus is trapped in the menu (ITrapFocusService), on [data-menu=close] first, and the page (body) takes the
+ * data-menu-page-show classes of the element (data-menu-page-hide once closed). The close button, the overlay, Escape
+ * and a click on a link of the menu close it; the focus goes back to what opened it.
  */
 export declare class BleetMenuCustomAttribute {
     private readonly logger;
@@ -15,20 +19,38 @@ export declare class BleetMenuCustomAttribute {
     private readonly p;
     private readonly transitionService;
     private readonly storageService;
+    private readonly trapFocusService;
     private disposable?;
     private disposableOverlay?;
     private closeButton?;
     private toggleButtons?;
     private sublists;
     private isOpen;
-    constructor(logger?: ILogger, ea?: IEventAggregator, element?: HTMLElement, p?: IPlatform, transitionService?: ITransitionService, storageService?: IStorageService);
+    private closingFromOverlay;
+    constructor(logger?: ILogger, ea?: IEventAggregator, element?: HTMLElement, p?: IPlatform, transitionService?: ITransitionService, storageService?: IStorageService, trapFocusService?: ITrapFocusService);
     attaching(): void;
     attached(): void;
     detaching(): void;
     dispose(): void;
+    /**
+     * The focus is trapped from what has it (the burger): it goes back there once the menu is closed. The trap starts
+     * once the show classes are set — the menu must be visible to take the focus. Its "outside" is the page: the
+     * click that opens the menu — outside the menu — would close it at once; the overlay, which covers the outside,
+     * closes it on a click.
+     */
     private open;
+    /**
+     * Every close stops the focus trap, which hides the menu (onStopTrapFocus): Escape stops it too. Closed in the
+     * frame it opens, the trap is not started yet: the menu is hidden at once.
+     */
     private close;
+    private hide;
+    private onStopTrapFocus;
     private onClickClose;
+    /**
+     * A link followed from the open menu closes it; the link is followed.
+     */
+    private onClickLink;
     private onClickToggleButtons;
     private initMenuButtons;
     /**

package/dist/types/attributes/menu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"menu.d.ts","sourceRoot":"","sources":["../../../src/attributes/menu.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,gBAAgB,EAAE,OAAO,EAAS,SAAS,EAAU,MAAM,SAAS,CAAC;AAG3G,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAG5D;;;;;;GAMG;AACH,qBACa,wBAAwB;IAS7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAZnC,OAAO,CAAC,UAAU,CAAC,CAAc;IACjC,OAAO,CAAC,iBAAiB,CAAC,CAAc;IACxC,OAAO,CAAC,WAAW,CAAC,CAAoB;IACxC,OAAO,CAAC,aAAa,CAAC,CAAgC;IACtD,OAAO,CAAC,QAAQ,CAA4E;IAC5F,OAAO,CAAC,MAAM,CAAkB;gBAEX,MAAM,GAAE,OAAgD,EACxD,EAAE,GAAC,gBAA4C,EAC/C,OAAO,GAAE,WAA2C,EACpD,CAAC,GAAE,SAA8B,EACjC,iBAAiB,GAAE,kBAAgD,EACnE,cAAc,GAAE,eAA0C;IAKxE,SAAS;IAOT,QAAQ;IASR,SAAS;IAQT,OAAO;IAMd,OAAO,CAAC,IAAI;IAgBZ,OAAO,CAAC,KAAK;IAiBb,OAAO,CAAC,YAAY,CAInB;IAED,OAAO,CAAC,oBAAoB,CAO3B;IAED,OAAO,CAAC,eAAe;IAOvB;;;OAGG;IACH,OAAO,CAAC,UAAU;IAYlB;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,WAAW,CAgBlB;IACD,OAAO,CAAC,eAAe,CAOtB;CACJ"}
+{"version":3,"file":"menu.d.ts","sourceRoot":"","sources":["../../../src/attributes/menu.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,gBAAgB,EAAE,OAAO,EAAS,SAAS,EAAU,MAAM,SAAS,CAAC;AAG3G,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAC,iBAAiB,EAAC,MAAM,gCAAgC,CAAC;AAGjE;;;;;;;;;GASG;AACH,qBACa,wBAAwB;IAU7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAdrC,OAAO,CAAC,UAAU,CAAC,CAAc;IACjC,OAAO,CAAC,iBAAiB,CAAC,CAAc;IACxC,OAAO,CAAC,WAAW,CAAC,CAAoB;IACxC,OAAO,CAAC,aAAa,CAAC,CAAgC;IACtD,OAAO,CAAC,QAAQ,CAA4E;IAC5F,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,kBAAkB,CAAkB;gBAEvB,MAAM,GAAE,OAAgD,EACxD,EAAE,GAAC,gBAA4C,EAC/C,OAAO,GAAE,WAA2C,EACpD,CAAC,GAAE,SAA8B,EACjC,iBAAiB,GAAE,kBAAgD,EACnE,cAAc,GAAE,eAA0C,EAC1D,gBAAgB,GAAE,iBAA8C;IAK9E,SAAS;IAOT,QAAQ;IAUR,SAAS;IAcT,OAAO;IAMd;;;;;OAKG;IACH,OAAO,CAAC,IAAI;IAsBZ;;;OAGG;IACH,OAAO,CAAC,KAAK;IAWb,OAAO,CAAC,IAAI;IAkBZ,OAAO,CAAC,eAAe,CAItB;IAED,OAAO,CAAC,YAAY,CAInB;IAED;;OAEG;IACH,OAAO,CAAC,WAAW,CAMlB;IAED,OAAO,CAAC,oBAAoB,CAO3B;IAED,OAAO,CAAC,eAAe;IAOvB;;;OAGG;IACH,OAAO,CAAC,UAAU;IAYlB;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,WAAW,CAgBlB;IACD,OAAO,CAAC,eAAe,CAOtB;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@blackcube/aurelia-kit",
-    "version": "1.0.0-rc6",
+    "version": "1.0.0-rc7",
     "description": "Blackcube Aurelia 2 kit: custom attributes and services driven by the Bleet PHP widgets",
     "author": "Philippe Gaultier <philippe@blackcube.io>",
     "license": "BSD-3-Clause",