@progress/kendo-angular-layout 7.0.0-next.202204060717 → 7.0.1-dev.202205020614

package/esm2015/panelbar/panelbar.component.js

@@ -13,6 +13,7 @@ import { PanelBarService } from "./panelbar.service";
 import { PanelBarItemTemplateDirective } from "./panelbar-item-template.directive";
 import { parsePanelBarItems } from "../common/util";
 import { isFocusable } from './../common/dom-queries';
+import { PanelBarSelectEvent, PanelBarExpandEvent, PanelBarCollapseEvent, PanelBarStateChangeEvent } from './events';
 import * as i0 from "@angular/core";
 import * as i1 from "./panelbar.service";
 import * as i2 from "@progress/kendo-angular-l10n";
@@ -48,17 +49,35 @@ export class PanelBarComponent {
          * Sets the height of the component when the `"full"` expand mode is used.
          * This option is ignored in the `"multiple"` and `"single"` expand modes.
          */
-        this.height = "400px";
+        this.height = '400px';
         /**
          * Fires each time the user interacts with a PanelBar item
          * ([see example]({% slug routing_panelbar %}#toc-getting-the-selected-item)).
-         * The event data contains all items that are modified.
+         * The event data contains a collection of all items that are modified.
          */
         this.stateChange = new EventEmitter();
+        /**
+         * Fires when an item is about to be selected.
+         * ([see example]({% slug events_panelbar %}))
+         * This event is preventable. If you cancel it, the item will not be selected.
+         */
+        this.select = new EventEmitter();
+        /**
+         * Fires when an item is about to be expanded.
+         * ([see example]({% slug events_panelbar %}))
+         * This event is preventable. If you cancel it, the item will remain collapsed.
+         */
+        this.expand = new EventEmitter();
+        /**
+         * Fires when an item is about to be collapsed.
+         * ([see example]({% slug events_panelbar %}))
+         * This event is preventable. If you cancel it, the item will remain expanded.
+         */
+        this.collapse = new EventEmitter();
         this.tabIndex = 0;
-        this.role = "tree";
+        this.role = 'tree';
         this.hostClass = true;
-        this.activeDescendant = "";
+        this.activeDescendant = '';
         this.isViewInit = true;
         this.focused = false;
         this._keepItemContent = false;
@@ -70,7 +89,7 @@ export class PanelBarComponent {
                 childrenHeight += item.headerHeight();
             });
             this.childrenItems.forEach(item => {
-                item.contentHeight = PanelBarExpandMode.Full === this.expandMode ? (panelbarHeight - childrenHeight) + "px" : 'auto';
+                item.contentHeight = PanelBarExpandMode.Full === this.expandMode ? (panelbarHeight - childrenHeight) + 'px' : 'auto';
                 item.contentOverflow = contentOverflow;
             });
         };
@@ -109,7 +128,7 @@ export class PanelBarComponent {
         return this.expandMode === PanelBarExpandMode.Full ? this.height : 'auto';
     }
     get overflow() {
-        return this.expandMode === PanelBarExpandMode.Full ? "hidden" : "visible";
+        return this.expandMode === PanelBarExpandMode.Full ? 'hidden' : 'visible';
     }
     get dir() {
         return this.localization.rtl ? 'rtl' : 'ltr';
@@ -159,7 +178,7 @@ export class PanelBarComponent {
         this.validateConfiguration();
     }
     ngOnChanges(changes) {
-        if (changes['height'] || changes['expandMode'] || changes["items"]) { // eslint-disable-line
+        if (changes['height'] || changes['expandMode'] || changes['items']) { // eslint-disable-line
             if (this.childrenItems) {
                 setTimeout(this.updateChildrenHeight);
             }
@@ -206,7 +225,7 @@ export class PanelBarComponent {
     onComponentBlur() {
         this.eventService.onBlur();
         this.focused = false;
-        this.activeDescendant = "";
+        this.activeDescendant = '';
     }
     /**
      * @hidden
@@ -225,6 +244,26 @@ export class PanelBarComponent {
             }
         }
     }
+    /**
+     * @hidden
+     */
+    emitEvent(event, item) {
+        let eventArgs;
+        switch (event) {
+            case 'select':
+                eventArgs = new PanelBarSelectEvent();
+                break;
+            case 'collapse':
+                eventArgs = new PanelBarCollapseEvent();
+                break;
+            default:
+                eventArgs = new PanelBarExpandEvent();
+                break;
+        }
+        eventArgs.item = item.serialize();
+        this[event].emit(eventArgs);
+        return eventArgs;
+    }
     get viewItems() {
         let treeItems = [];
         this.viewChildItems.toArray().forEach(item => {
@@ -236,7 +275,7 @@ export class PanelBarComponent {
     validateConfiguration() {
         if (isDevMode()) {
             if (this.items && (this.contentItems && this.contentItems.length > 0)) {
-                throw new Error("Invalid configuration: mixed template components and items property.");
+                throw new Error('Invalid configuration: mixed template components and items property.');
             }
         }
     }
@@ -251,37 +290,80 @@ export class PanelBarComponent {
             let focusedState = selectedState;
             selectedState = this.selectable ? selectedState : currentItem.selected;
             if (currentItem.selected !== selectedState || currentItem.focused !== focusedState) {
-                currentItem.selected = selectedState;
-                currentItem.focused = focusedState;
-                this.activeDescendant = focusedState ? currentItem.itemId : "";
-                modifiedItems.push(currentItem);
+                const isSelectPrevented = selectedState ? this.emitEvent('select', currentItem).isDefaultPrevented() : false;
+                if (!isSelectPrevented) {
+                    currentItem.selected = selectedState;
+                    currentItem.focused = focusedState;
+                    this.activeDescendant = focusedState ? currentItem.itemId : '';
+                    modifiedItems.push(currentItem);
+                }
             }
         });
         if (this.expandMode === PanelBarExpandMode.Multiple) {
-            if (item.hasChildItems || item.hasContent) {
-                item.expanded = !item.expanded;
-            }
-            if (modifiedItems.indexOf(item) < 0) {
-                modifiedItems.push(item);
+            if ((item.hasChildItems || item.hasContent) && item.selected) {
+                const isEventPrevented = item.expanded ?
+                    this.emitEvent('collapse', item).isDefaultPrevented() :
+                    this.emitEvent('expand', item).isDefaultPrevented();
+                if (!isEventPrevented) {
+                    item.expanded = !item.expanded;
+                    if (modifiedItems.indexOf(item) < 0) {
+                        modifiedItems.push(item);
+                    }
+                }
             }
         }
         else {
             let siblings = item.parent ? item.parent.childrenItems : this.childrenItems;
-            if (item.hasChildItems || item.hasContent) {
+            let preventedCollapseItem;
+            let expandedItems = [];
+            if ((item.hasChildItems || item.hasContent) && item.selected) {
                 siblings
                     .forEach((currentItem) => {
                     let expandedState = currentItem === item;
                     if (currentItem.expanded !== expandedState) {
-                        currentItem.expanded = expandedState;
-                        if (modifiedItems.indexOf(currentItem) < 0) {
-                            modifiedItems.push(currentItem);
+                        const isEventPrevented = currentItem.expanded ?
+                            this.emitEvent('collapse', currentItem).isDefaultPrevented() :
+                            this.emitEvent('expand', currentItem).isDefaultPrevented();
+                        if (!isEventPrevented) {
+                            currentItem.expanded = expandedState;
+                            if (currentItem.expanded) {
+                                expandedItems.push(currentItem);
+                            }
+                            if (modifiedItems.indexOf(currentItem) < 0) {
+                                modifiedItems.push(currentItem);
+                            }
+                        }
+                        else if (isEventPrevented && currentItem.expanded) {
+                            preventedCollapseItem = currentItem;
+                        }
+                    }
+                    else if (currentItem.expanded === expandedState && expandedState) {
+                        const isCollapsePrevented = this.emitEvent('collapse', currentItem).isDefaultPrevented();
+                        if (!isCollapsePrevented) {
+                            currentItem.expanded = !currentItem.expanded;
+                            if (modifiedItems.indexOf(currentItem) < 0) {
+                                modifiedItems.push(currentItem);
+                            }
+                        }
+                    }
+                });
+                expandedItems.forEach(item => {
+                    if (preventedCollapseItem && item.id !== preventedCollapseItem.id) {
+                        item.expanded = false;
+                        if (isDevMode()) {
+                            const expandMode = PanelBarExpandMode[this.expandMode].toLowerCase();
+                            console.warn(`
+                            The ${expandMode} expandMode allows the expansion of only one item at a time.
+                            See https://www.telerik.com/kendo-angular-ui-develop/components/layout/panelbar/expand-modes/`);
                         }
                     }
                 });
             }
         }
         if (modifiedItems.length > 0) {
-            this.stateChange.emit(modifiedItems.map(currentItem => currentItem.serialize()));
+            let eventArgs = new PanelBarStateChangeEvent();
+            eventArgs.items = modifiedItems.map(currentItem => currentItem.serialize());
+            this.stateChange.emit(eventArgs);
         }
     }
     isVisible(item) {
@@ -307,16 +389,16 @@ export class PanelBarComponent {
             currentIndex = visibleItems.findIndex(item => item === currentItem);
         }
         switch (action) {
-            case "lastItem":
+            case 'lastItem':
                 nextItem = visibleItems[visibleItems.length - 1];
                 break;
-            case "firstItem":
+            case 'firstItem':
                 nextItem = visibleItems[0];
                 break;
-            case "nextItem":
+            case 'nextItem':
                 nextItem = visibleItems[currentIndex < visibleItems.length - 1 ? currentIndex + 1 : 0];
                 break;
-            case "previousItem":
+            case 'previousItem':
                 nextItem = visibleItems[currentIndex > 0 ? currentIndex - 1 : visibleItems.length - 1];
                 break;
             default:
@@ -330,19 +412,21 @@ export class PanelBarComponent {
         to.focused = true;
         this.activeDescendant = to.itemId;
         const modifiedItems = new Array(from.serialize(), to.serialize());
-        this.stateChange.emit(modifiedItems);
+        let eventArgs = new PanelBarStateChangeEvent();
+        eventArgs.items = modifiedItems;
+        this.stateChange.emit(eventArgs);
     }
     focusLastItem() {
-        this.focusItem("lastItem");
+        this.focusItem('lastItem');
     }
     focusFirstItem() {
-        this.focusItem("firstItem");
+        this.focusItem('firstItem');
     }
     focusNextItem() {
-        this.focusItem("nextItem");
+        this.focusItem('nextItem');
     }
     focusPreviousItem() {
-        this.focusItem("previousItem");
+        this.focusItem('previousItem');
     }
     expandItem() {
         let currentItem = this.allItems.filter(item => item.focused)[0];
@@ -395,7 +479,7 @@ export class PanelBarComponent {
     }
 }
 PanelBarComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: PanelBarComponent, deps: [{ token: i0.ElementRef }, { token: i1.PanelBarService }, { token: i2.LocalizationService }], target: i0.ɵɵFactoryTarget.Component });
-PanelBarComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "12.2.16", type: PanelBarComponent, selector: "kendo-panelbar", inputs: { expandMode: "expandMode", selectable: "selectable", animate: "animate", height: "height", keepItemContent: "keepItemContent", items: "items" }, outputs: { stateChange: "stateChange" }, host: { listeners: { "click": "onComponentClick($event)", "focus": "onComponentFocus()", "blur": "onComponentBlur()", "keydown": "onComponentKeyDown($event)" }, properties: { "attr.tabIndex": "this.tabIndex", "attr.role": "this.role", "class.k-panelbar": "this.hostClass", "attr.aria-activedescendant": "this.activeDescendant", "style.height": "this.hostHeight", "style.overflow": "this.overflow", "attr.dir": "this.dir" } }, providers: [
+PanelBarComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "12.2.16", type: PanelBarComponent, selector: "kendo-panelbar", inputs: { expandMode: "expandMode", selectable: "selectable", animate: "animate", height: "height", keepItemContent: "keepItemContent", items: "items" }, outputs: { stateChange: "stateChange", select: "select", expand: "expand", collapse: "collapse" }, host: { listeners: { "click": "onComponentClick($event)", "focus": "onComponentFocus()", "blur": "onComponentBlur()", "keydown": "onComponentKeyDown($event)" }, properties: { "attr.tabIndex": "this.tabIndex", "attr.role": "this.role", "class.k-panelbar": "this.hostClass", "attr.aria-activedescendant": "this.activeDescendant", "style.height": "this.hostHeight", "style.overflow": "this.overflow", "attr.dir": "this.dir" } }, providers: [
         PanelBarService,
         LocalizationService,
         {
@@ -407,17 +491,17 @@ PanelBarComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", vers
         <ng-template [ngIf]="items?.length">
             <ng-container *ngFor="let item of items">
                 <kendo-panelbar-item *ngIf="!item.hidden"
-                     [title]="item.title"
-                     [id]="item.id"
-                     [icon]="item.icon"
-                     [iconClass]="item.iconClass"
-                     [imageUrl]="item.imageUrl"
-                     [selected]="!!item.selected"
-                     [expanded]="!!item.expanded"
-                     [disabled]="!!item.disabled"
-                     [template]="templateRef"
-                     [items]="item.children"
-                     [content]="item.content"
+                    [title]="item.title"
+                    [id]="item.id"
+                    [icon]="item.icon"
+                    [iconClass]="item.iconClass"
+                    [imageUrl]="item.imageUrl"
+                    [selected]="!!item.selected"
+                    [expanded]="!!item.expanded"
+                    [disabled]="!!item.disabled"
+                    [template]="templateRef"
+                    [items]="item.children"
+                    [content]="item.content"
                 >
                 </kendo-panelbar-item>
             </ng-container>
@@ -441,17 +525,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImpo
         <ng-template [ngIf]="items?.length">
             <ng-container *ngFor="let item of items">
                 <kendo-panelbar-item *ngIf="!item.hidden"
-                     [title]="item.title"
-                     [id]="item.id"
-                     [icon]="item.icon"
-                     [iconClass]="item.iconClass"
-                     [imageUrl]="item.imageUrl"
-                     [selected]="!!item.selected"
-                     [expanded]="!!item.expanded"
-                     [disabled]="!!item.disabled"
-                     [template]="templateRef"
-                     [items]="item.children"
-                     [content]="item.content"
+                    [title]="item.title"
+                    [id]="item.id"
+                    [icon]="item.icon"
+                    [iconClass]="item.iconClass"
+                    [imageUrl]="item.imageUrl"
+                    [selected]="!!item.selected"
+                    [expanded]="!!item.expanded"
+                    [disabled]="!!item.disabled"
+                    [template]="templateRef"
+                    [items]="item.children"
+                    [content]="item.content"
                 >
                 </kendo-panelbar-item>
             </ng-container>
@@ -472,6 +556,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImpo
                 type: Input
             }], stateChange: [{
                 type: Output
+            }], select: [{
+                type: Output
+            }], expand: [{
+                type: Output
+            }], collapse: [{
+                type: Output
             }], tabIndex: [{
                 type: HostBinding,
                 args: ['attr.tabIndex']