@progress/kendo-angular-listbox 0.1.0

package/dist/fesm2015/index.js

@@ -0,0 +1,565 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { __decorate, __metadata } from 'tslib';
+import { EventEmitter, Injectable, Directive, TemplateRef, isDevMode, HostBinding, ContentChild, Input, Output, Component, Renderer2, ElementRef, HostListener, NgModule } from '@angular/core';
+import { validatePackage } from '@progress/kendo-licensing';
+import { Subscription } from 'rxjs';
+import { getter } from '@progress/kendo-common';
+import { isChanged } from '@progress/kendo-angular-common';
+import { ButtonsModule } from '@progress/kendo-angular-buttons';
+import { CommonModule } from '@angular/common';
+
+/**
+ * @hidden
+ */
+const packageMetadata = {
+    name: '@progress/kendo-angular-listbox',
+    productName: 'Kendo UI for Angular',
+    productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
+    publishDate: 1649835747,
+    version: '',
+    licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning'
+};
+
+/**
+ * @hidden
+ */
+let ListBoxSelectionService = class ListBoxSelectionService {
+    /**
+     * @hidden
+     */
+    constructor() {
+        this.onSelect = new EventEmitter();
+        this.selectedIndex = null;
+    }
+    select(index) {
+        this.selectedIndex = index;
+        this.onSelect.next({ index: this.selectedIndex });
+    }
+    isSelected(index) {
+        return index === this.selectedIndex;
+    }
+    clearSelection() {
+        this.selectedIndex = null;
+    }
+};
+ListBoxSelectionService = __decorate([
+    Injectable()
+], ListBoxSelectionService);
+
+/**
+ * Renders the ListBox item content. To define the item template, nest an `<ng-template>` tag
+ * with the `kendoListBoxItemTemplate` directive inside the `<kendo-listbox>` tag. The template context is
+ * set to the current data item.
+ *
+ * @example
+ * ```ts
+ * _@Component({
+ * selector: 'my-app',
+ * template: `
+ *   <kendo-listbox [data]="listBoxItems">
+ *     <ng-template kendoListBoxItemTemplate let-dataItem>
+ *       <span>{{ dataItem }} item</span>
+ *     </ng-template>
+ *   </kendo-listbox>
+ * `
+ * })
+ * ```
+ */
+let ItemTemplateDirective = class ItemTemplateDirective {
+    constructor(templateRef) {
+        this.templateRef = templateRef;
+    }
+};
+ItemTemplateDirective = __decorate([
+    Directive({
+        selector: '[kendoListBoxItemTemplate]'
+    }),
+    __metadata("design:paramtypes", [TemplateRef])
+], ItemTemplateDirective);
+
+/**
+ * @hidden
+ */
+const DEFAULT_TOOLBAR_POSITION = 'right';
+/**
+ * @hidden
+ */
+const allTools = [
+    {
+        name: 'moveUp',
+        label: 'Move Up',
+        icon: 'arrow-n'
+    },
+    {
+        name: 'moveDown',
+        label: 'Move Down',
+        icon: 'arrow-s'
+    },
+    {
+        name: 'transferTo',
+        label: 'Transfer From',
+        icon: 'arrow-w'
+    },
+    {
+        name: 'transferFrom',
+        label: 'Transfer To',
+        icon: 'arrow-e'
+    },
+    {
+        name: 'transferAllTo',
+        label: 'Transfer All To',
+        icon: 'arrow-double-60-right'
+    },
+    {
+        name: 'transferAllFrom',
+        label: 'Transfer All From',
+        icon: 'arrow-double-60-left'
+    },
+    {
+        name: 'remove',
+        label: 'Remove',
+        icon: 'x'
+    }
+];
+/**
+ * @hidden
+ */
+const sizeClassMap = {
+    small: 'sm',
+    medium: 'md',
+    large: 'lg'
+};
+/**
+ * @hidden
+ */
+const toolbarClasses = {
+    left: 'k-listbox-toolbar-left',
+    right: 'k-listbox-toolbar-right',
+    top: 'k-listbox-toolbar-top',
+    bottom: 'k-listbox-toolbar-bottom'
+};
+
+/**
+ * @hidden
+ */
+const isPresent = (value) => value !== null && value !== undefined;
+/**
+ * @hidden
+ */
+const isObject = (value) => isPresent(value) && typeof value === 'object';
+/**
+ * @hidden
+ */
+const fieldAccessor = (dataItem, field) => {
+    if (!isPresent(dataItem)) {
+        return null;
+    }
+    if (!isPresent(field) || !isObject(dataItem)) {
+        return dataItem;
+    }
+    // creates a field accessor supporting nested fields processing
+    const valueFrom = getter(field);
+    return valueFrom(dataItem);
+};
+/**
+ * @hidden
+ */
+const defaultItemDisabled = () => false;
+/**
+ * @hidden
+ */
+const getTools = (names) => {
+    return names.map(tool => allTools.find(meta => meta.name === tool));
+};
+
+/**
+ * Represents the [Kendo UI ListBox component for Angular]({% slug overview_listbox %}).
+ */
+let ListBoxComponent = class ListBoxComponent {
+    constructor(selectionService, renderer, hostElement) {
+        this.selectionService = selectionService;
+        this.renderer = renderer;
+        this.hostElement = hostElement;
+        /**
+         * @hidden
+         */
+        this.listboxClassName = true;
+        /**
+         * The data which will be displayed by the ListBox.
+         */
+        this.data = [];
+        /**
+         * Sets the size of the component.
+         *
+         * The possible values are:
+         * - `'small'`
+         * - `'medium'` (default)
+         * - `'large'`
+         */
+        this.size = 'medium';
+        /**
+         * A function which determines if a specific item is disabled.
+         */
+        this.itemDisabled = defaultItemDisabled;
+        /**
+         * Fires when the user selects a different ListBox item. Also fires when a node is moved, since that also changes its index.
+         */
+        this.selectionChange = new EventEmitter();
+        /**
+         * Fires when the user clicks a ListBox item.
+         */
+        this.actionClick = new EventEmitter();
+        /**
+         * @hidden
+         */
+        this.selectedTools = allTools;
+        this.sub = new Subscription();
+        validatePackage(packageMetadata);
+        this.setToolbarClass(DEFAULT_TOOLBAR_POSITION);
+        this.sub.add(this.selectionService.onSelect.subscribe((e) => {
+            this.selectionChange.next(e);
+        }));
+    }
+    /**
+     * Sets whether a toolbar should be displayed with the ListBox, as well as what tools and position should be used.
+     */
+    set toolbar(config) {
+        let position = DEFAULT_TOOLBAR_POSITION;
+        if (typeof config === 'boolean') {
+            this.selectedTools = config ? allTools : [];
+        }
+        else {
+            this.selectedTools = config.tools ? getTools(config.tools) : allTools;
+            if (config.position) {
+                position = config.position;
+            }
+        }
+        this.setToolbarClass(position);
+    }
+    /**
+     * @hidden
+     */
+    get listClasses() {
+        return `k-list k-list-${sizeClassMap[this.size]}`;
+    }
+    /**
+     * @hidden
+     */
+    ngOnDestroy() {
+        this.sub.unsubscribe();
+    }
+    /**
+     * @hidden
+     */
+    performAction(actionName) {
+        this.actionClick.next(actionName);
+    }
+    /**
+     * Programmatically selects a ListBox node.
+     */
+    selectItem(index) {
+        this.selectionService.selectedIndex = index;
+    }
+    /**
+     * Programmatically clears the ListBox selection.
+     */
+    clearSelection() {
+        this.selectionService.clearSelection();
+    }
+    /**
+     * The index of the currently selected item in the ListBox.
+     */
+    get selectedIndex() {
+        return this.selectionService.selectedIndex;
+    }
+    /**
+     * @hidden
+     */
+    getText(dataItem) {
+        if (typeof dataItem !== 'string' && !this.textField && isDevMode()) {
+            throw new Error('Missing textField input. When passing an array of objects as data, please set the textField input of the ListBox accordingly.');
+        }
+        return fieldAccessor(dataItem, this.textField);
+    }
+    setToolbarClass(pos) {
+        Object.keys(toolbarClasses).forEach((className) => {
+            if (pos === className) {
+                this.renderer.addClass(this.hostElement.nativeElement, toolbarClasses[className]);
+            }
+            else {
+                this.renderer.removeClass(this.hostElement.nativeElement, toolbarClasses[className]);
+            }
+        });
+    }
+};
+__decorate([
+    HostBinding('class.k-listbox'),
+    __metadata("design:type", Boolean)
+], ListBoxComponent.prototype, "listboxClassName", void 0);
+__decorate([
+    ContentChild(ItemTemplateDirective, { static: false }),
+    __metadata("design:type", ItemTemplateDirective)
+], ListBoxComponent.prototype, "itemTemplate", void 0);
+__decorate([
+    Input(),
+    __metadata("design:type", String)
+], ListBoxComponent.prototype, "textField", void 0);
+__decorate([
+    Input(),
+    __metadata("design:type", Array)
+], ListBoxComponent.prototype, "data", void 0);
+__decorate([
+    Input(),
+    __metadata("design:type", String)
+], ListBoxComponent.prototype, "size", void 0);
+__decorate([
+    Input(),
+    __metadata("design:type", Object),
+    __metadata("design:paramtypes", [Object])
+], ListBoxComponent.prototype, "toolbar", null);
+__decorate([
+    Input(),
+    __metadata("design:type", Function)
+], ListBoxComponent.prototype, "itemDisabled", void 0);
+__decorate([
+    Output(),
+    __metadata("design:type", EventEmitter)
+], ListBoxComponent.prototype, "selectionChange", void 0);
+__decorate([
+    Output(),
+    __metadata("design:type", EventEmitter)
+], ListBoxComponent.prototype, "actionClick", void 0);
+ListBoxComponent = __decorate([
+    Component({
+        selector: 'kendo-listbox',
+        providers: [ListBoxSelectionService],
+        template: `
+            <div class="k-listbox-toolbar" *ngIf="selectedTools.length > 0">
+                <ul class="k-reset">
+                    <li *ngFor="let tool of selectedTools">
+                        <button kendoButton [icon]="tool.icon" (click)="performAction(tool.name)"></button>
+                    </li>
+
+                    <!-- react moving items has a smoother removal of the style: https://www.telerik.com/kendo-react-ui/components/listbox/ -->
+                </ul>
+            </div>
+            <div class="k-list-scroller k-selectable">
+                <div class="{{ listClasses }}">
+                    <div class="k-list-content">
+                        <ul class="k-list-ul">
+                            <li
+                                class="k-list-item"
+                                *ngFor="let item of data; let i = index;"
+                                kendoListBoxItemSelectable
+                                [index]="i"
+                                [class.k-disabled]="itemDisabled(item)"
+                            >
+                                <ng-template *ngIf="itemTemplate; else defaultItemTemplate"
+                                    [templateContext]="{
+                                        templateRef: itemTemplate.templateRef,
+                                        $implicit: item
+                                    }">
+                                </ng-template>
+                                <ng-template #defaultItemTemplate>
+                                    <span class="k-list-item-text">{{ getText(item) }}</span>
+                                </ng-template>
+                            </li>
+                        </ul>
+                    </div>
+                </div>
+            </div>
+    `
+    }),
+    __metadata("design:paramtypes", [ListBoxSelectionService,
+        Renderer2,
+        ElementRef])
+], ListBoxComponent);
+
+/**
+ * A directive which manages the functoinality of the ListBox tools out of the box, and modifies the provided data accordingly.
+ */
+let DataBindingDirective = class DataBindingDirective {
+    constructor(listbox) {
+        this.listbox = listbox;
+        /**
+         * @hidden
+         */
+        this.data = [];
+        this.sub = new Subscription();
+        this.selectedBox = this.listbox;
+        this.sub.add(this.listbox.actionClick.subscribe((actionName) => {
+            switch (actionName) {
+                case 'moveUp': {
+                    this.moveVertically('up');
+                    break;
+                }
+                case 'moveDown': {
+                    this.moveVertically('down');
+                    break;
+                }
+                case 'transferTo': {
+                    this.transferItem(this.connectedWith, this.listbox);
+                    break;
+                }
+                case 'transferFrom': {
+                    this.transferItem(this.listbox, this.connectedWith);
+                    break;
+                }
+                case 'transferAllTo': {
+                    this.transferAll(this.listbox, this.connectedWith);
+                    break;
+                }
+                case 'transferAllFrom': {
+                    this.transferAll(this.connectedWith, this.listbox);
+                    break;
+                }
+                case 'remove': {
+                    this.removeItem();
+                    break;
+                }
+                default: {
+                    break;
+                }
+            }
+        }));
+    }
+    /**
+     * @hidden
+     */
+    ngOnChanges(changes) {
+        if (isChanged('connectedWith', changes, false)) {
+            this.sub.add(this.listbox.selectionChange.subscribe(() => {
+                this.selectedBox = this.listbox;
+                this.connectedWith.clearSelection();
+            }));
+            this.sub.add(this.connectedWith.selectionChange.subscribe(() => {
+                this.selectedBox = this.connectedWith;
+                this.listbox.clearSelection();
+            }));
+        }
+        if (isChanged('data', changes, true)) {
+            this.listbox.data = changes.data.currentValue;
+        }
+    }
+    /**
+     * @hidden
+     */
+    ngOnDestroy() {
+        this.sub.unsubscribe();
+    }
+    moveVertically(dir) {
+        const index = this.selectedBox.selectedIndex;
+        if (!isPresent(index)) {
+            return;
+        }
+        const topReached = dir === 'up' && index <= 0;
+        const bottomReached = dir === 'down' && index >= this.selectedBox.data.length - 1;
+        if (topReached || bottomReached) {
+            return;
+        }
+        const newIndex = dir === 'up' ? index - 1 : index + 1;
+        // ES6 Destructuring swap
+        [this.selectedBox.data[newIndex], this.selectedBox.data[index]] = [this.selectedBox.data[index], this.selectedBox.data[newIndex]];
+        this.selectedBox.selectionService.select(newIndex);
+    }
+    removeItem() {
+        const index = this.selectedBox.selectedIndex;
+        if (!isPresent(index)) {
+            return;
+        }
+        this.selectedBox.data.splice(index, 1);
+        this.selectedBox.selectionService.clearSelection();
+    }
+    transferItem(source, target) {
+        const item = source && source.data[source.selectedIndex];
+        if (!item || !target || !source) {
+            return;
+        }
+        target.data.push(item);
+        source.data.splice(source.selectedIndex, 1);
+        source.clearSelection();
+        target.selectItem(target.data.length - 1);
+        this.selectedBox = target;
+    }
+    transferAll(source, target) {
+        if (!target || !source) {
+            return;
+        }
+        target.data.splice(target.data.length, 0, ...source.data.splice(0, source.data.length));
+        target.selectItem(target.data.length - 1);
+        this.selectedBox = target;
+    }
+};
+__decorate([
+    Input('kendoListBoxDataBinding'),
+    __metadata("design:type", Array)
+], DataBindingDirective.prototype, "data", void 0);
+__decorate([
+    Input(),
+    __metadata("design:type", ListBoxComponent)
+], DataBindingDirective.prototype, "connectedWith", void 0);
+DataBindingDirective = __decorate([
+    Directive({
+        selector: '[kendoListBoxDataBinding]'
+    }),
+    __metadata("design:paramtypes", [ListBoxComponent])
+], DataBindingDirective);
+
+/**
+ * @hidden
+ */
+let ItemSelectableDirective = class ItemSelectableDirective {
+    constructor(selectionService) {
+        this.selectionService = selectionService;
+    }
+    get selectedClassName() {
+        return this.selectionService.isSelected(this.index);
+    }
+    onClick(event) {
+        event.stopPropagation();
+        this.selectionService.select(this.index);
+    }
+};
+__decorate([
+    Input(),
+    __metadata("design:type", Number)
+], ItemSelectableDirective.prototype, "index", void 0);
+__decorate([
+    HostBinding('class.k-selected'),
+    __metadata("design:type", Boolean),
+    __metadata("design:paramtypes", [])
+], ItemSelectableDirective.prototype, "selectedClassName", null);
+__decorate([
+    HostListener('click', ['$event']),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ItemSelectableDirective.prototype, "onClick", null);
+ItemSelectableDirective = __decorate([
+    Directive({
+        selector: '[kendoListBoxItemSelectable]'
+    }),
+    __metadata("design:paramtypes", [ListBoxSelectionService])
+], ItemSelectableDirective);
+
+/**
+ * Represents the [NgModule](https://angular.io/api/core/NgModule) definition for the ListBox component.
+ */
+let ListBoxModule = class ListBoxModule {
+};
+ListBoxModule = __decorate([
+    NgModule({
+        imports: [ButtonsModule, CommonModule],
+        declarations: [ListBoxComponent, ItemTemplateDirective, ItemSelectableDirective, DataBindingDirective],
+        exports: [ListBoxComponent, ItemTemplateDirective, ItemSelectableDirective, DataBindingDirective]
+    })
+], ListBoxModule);
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { ItemSelectableDirective, ItemTemplateDirective, ListBoxSelectionService, ListBoxComponent, DataBindingDirective, ListBoxModule };