@progress/kendo-angular-treelist 3.1.3-dev.202110041229

package/dist/es2015/columns/column.component.d.ts

@@ -0,0 +1,139 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { TemplateRef } from '@angular/core';
+import { CellTemplateDirective } from '../rendering/cell-template.directive';
+import { EditTemplateDirective } from '../editing/edit-template.directive';
+import { ColumnSortSettings } from './sort-settings';
+import { ColumnBase } from './column-base';
+import { FilterCellTemplateDirective } from '../filtering/cell/filter-cell-template.directive';
+import { FilterMenuTemplateDirective } from '../filtering/menu/filter-menu-template.directive';
+import { OptionChangesService } from '../common/option-changes.service';
+/**
+ * @hidden
+ */
+export declare function isColumnComponent(column: any): column is ColumnComponent;
+/**
+ * Represents the columns of the [Angular TreeList]({% slug getstarted_treelist %}).
+ *
+ * {% meta height:470 %}
+ * {% embed_file basic-usage/app.component.ts preview %}
+ * {% embed_file basic-usage/app.module.ts %}
+ * {% embed_file shared/main.ts %}
+ * {% embed_file shared/employees.ts %}
+ * {% endmeta %}
+ */
+export declare class ColumnComponent extends ColumnBase {
+    /**
+     * Defines whether the expanded indicator should be rendered in the column.
+     * @default false
+     */
+    expandable: boolean;
+    /**
+     * The field to which the column is bound.
+     */
+    field: string;
+    /**
+     * The format that is applied to the value before it is displayed.
+     * Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
+     * a standard date format, a custom date format or a format object. For more information on the supported date and number formats,
+     * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
+     *
+     * Standard format:
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="UnitPrice" format="{0:c}">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     *
+     * Format object for currency:
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="UnitPrice" [format]="{ style: 'currency', currency: 'EUR' }">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     *
+     * Format object for dates:
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="FirstOrderedOn" [format]="{ date: 'short' }">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     */
+    format: any;
+    /**
+     * Allows the column headers to be clicked and the `sortChange` event emitted.
+     * You have to handle the `sortChange` event yourself and sort the data.
+     */
+    sortable: boolean | ColumnSortSettings;
+    /**
+     * Defines the editor type ([see example]({% slug editing_reactive_forms_treelist %}#toc-setup)).
+     * Used when the column enters the edit mode. The default value is `text`.
+     *
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="UnitPrice" editor="numeric">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     */
+    editor: 'text' | 'numeric' | 'date' | 'boolean';
+    /**
+     * Defines the filter type that is displayed inside the filter row. The default value is `text`.
+     *
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="UnitPrice" filter="numeric">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     */
+    filter: 'text' | 'numeric' | 'boolean' | 'date';
+    /**
+     * Defines if a filter UI will be displayed for this column. The default value is `true`.
+     *
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="UnitPrice" [filterable]="false">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     */
+    filterable: boolean;
+    /**
+     * Defines whether the column is editable. The default value is `true`.
+     *
+     * @example
+     * ```html-no-run
+     * <kendo-treelist>
+     *    <kendo-treelist-column field="UnitPrice" [editable]="false">
+     *    </kendo-treelist-column>
+     * </kendo-treelist>
+     * ```
+     */
+    editable: boolean;
+    template: CellTemplateDirective;
+    editTemplate: EditTemplateDirective;
+    filterCellTemplate: FilterCellTemplateDirective;
+    filterMenuTemplate: FilterMenuTemplateDirective;
+    constructor(parent?: ColumnBase, optionChanges?: OptionChangesService);
+    readonly templateRef: TemplateRef<any>;
+    readonly editTemplateRef: TemplateRef<any>;
+    readonly filterCellTemplateRef: TemplateRef<any>;
+    readonly filterMenuTemplateRef: TemplateRef<any>;
+    readonly displayTitle: string;
+    /**
+     * @hidden
+     */
+    readonly isEditable: boolean;
+}

package/dist/es2015/columns/column.component.js

@@ -0,0 +1,173 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+var ColumnComponent_1;
+import { forwardRef, Component, Input, ContentChild, SkipSelf, Host, Optional } from '@angular/core';
+import { CellTemplateDirective } from '../rendering/cell-template.directive';
+import { EditTemplateDirective } from '../editing/edit-template.directive';
+import { ColumnBase } from './column-base';
+import { isPresent } from '../utils';
+import { FilterCellTemplateDirective } from '../filtering/cell/filter-cell-template.directive';
+import { FilterMenuTemplateDirective } from '../filtering/menu/filter-menu-template.directive';
+import { OptionChangesService } from '../common/option-changes.service';
+/**
+ * @hidden
+ */
+export function isColumnComponent(column) {
+    return isPresent(column.field);
+}
+/**
+ * Represents the columns of the [Angular TreeList]({% slug getstarted_treelist %}).
+ *
+ * {% meta height:470 %}
+ * {% embed_file basic-usage/app.component.ts preview %}
+ * {% embed_file basic-usage/app.module.ts %}
+ * {% embed_file shared/main.ts %}
+ * {% embed_file shared/employees.ts %}
+ * {% endmeta %}
+ */
+let ColumnComponent = ColumnComponent_1 = class ColumnComponent extends ColumnBase {
+    constructor(parent, optionChanges) {
+        super(parent, optionChanges);
+        /**
+         * Allows the column headers to be clicked and the `sortChange` event emitted.
+         * You have to handle the `sortChange` event yourself and sort the data.
+         */
+        this.sortable = true;
+        /**
+         * Defines the editor type ([see example]({% slug editing_reactive_forms_treelist %}#toc-setup)).
+         * Used when the column enters the edit mode. The default value is `text`.
+         *
+         * @example
+         * ```html-no-run
+         * <kendo-treelist>
+         *    <kendo-treelist-column field="UnitPrice" editor="numeric">
+         *    </kendo-treelist-column>
+         * </kendo-treelist>
+         * ```
+         */
+        this.editor = 'text';
+        /**
+         * Defines the filter type that is displayed inside the filter row. The default value is `text`.
+         *
+         * @example
+         * ```html-no-run
+         * <kendo-treelist>
+         *    <kendo-treelist-column field="UnitPrice" filter="numeric">
+         *    </kendo-treelist-column>
+         * </kendo-treelist>
+         * ```
+         */
+        this.filter = 'text';
+        /**
+         * Defines if a filter UI will be displayed for this column. The default value is `true`.
+         *
+         * @example
+         * ```html-no-run
+         * <kendo-treelist>
+         *    <kendo-treelist-column field="UnitPrice" [filterable]="false">
+         *    </kendo-treelist-column>
+         * </kendo-treelist>
+         * ```
+         */
+        this.filterable = true;
+        /**
+         * Defines whether the column is editable. The default value is `true`.
+         *
+         * @example
+         * ```html-no-run
+         * <kendo-treelist>
+         *    <kendo-treelist-column field="UnitPrice" [editable]="false">
+         *    </kendo-treelist-column>
+         * </kendo-treelist>
+         * ```
+         */
+        this.editable = true;
+    }
+    get templateRef() {
+        return this.template ? this.template.templateRef : undefined;
+    }
+    get editTemplateRef() {
+        return this.editTemplate ? this.editTemplate.templateRef : undefined;
+    }
+    get filterCellTemplateRef() {
+        return this.filterCellTemplate ? this.filterCellTemplate.templateRef : undefined;
+    }
+    get filterMenuTemplateRef() {
+        return this.filterMenuTemplate ? this.filterMenuTemplate.templateRef : undefined;
+    }
+    get displayTitle() {
+        return this.title === undefined ? this.field : this.title;
+    }
+    /**
+     * @hidden
+     */
+    get isEditable() {
+        return this.editable !== false;
+    }
+};
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ColumnComponent.prototype, "expandable", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", String)
+], ColumnComponent.prototype, "field", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Object)
+], ColumnComponent.prototype, "format", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Object)
+], ColumnComponent.prototype, "sortable", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", String)
+], ColumnComponent.prototype, "editor", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", String)
+], ColumnComponent.prototype, "filter", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ColumnComponent.prototype, "filterable", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ColumnComponent.prototype, "editable", void 0);
+tslib_1.__decorate([
+    ContentChild(CellTemplateDirective, { static: false }),
+    tslib_1.__metadata("design:type", CellTemplateDirective)
+], ColumnComponent.prototype, "template", void 0);
+tslib_1.__decorate([
+    ContentChild(EditTemplateDirective, { static: false }),
+    tslib_1.__metadata("design:type", EditTemplateDirective)
+], ColumnComponent.prototype, "editTemplate", void 0);
+tslib_1.__decorate([
+    ContentChild(FilterCellTemplateDirective, { static: false }),
+    tslib_1.__metadata("design:type", FilterCellTemplateDirective)
+], ColumnComponent.prototype, "filterCellTemplate", void 0);
+tslib_1.__decorate([
+    ContentChild(FilterMenuTemplateDirective, { static: false }),
+    tslib_1.__metadata("design:type", FilterMenuTemplateDirective)
+], ColumnComponent.prototype, "filterMenuTemplate", void 0);
+ColumnComponent = ColumnComponent_1 = tslib_1.__decorate([
+    Component({
+        providers: [
+            {
+                provide: ColumnBase,
+                useExisting: forwardRef(() => ColumnComponent_1)
+            }
+        ],
+        selector: 'kendo-treelist-column',
+        template: ``
+    }),
+    tslib_1.__param(0, SkipSelf()), tslib_1.__param(0, Host()), tslib_1.__param(0, Optional()),
+    tslib_1.__metadata("design:paramtypes", [ColumnBase, OptionChangesService])
+], ColumnComponent);
+export { ColumnComponent };

package/dist/es2015/columns/columns-container.d.ts

@@ -0,0 +1,27 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { QueryList, EventEmitter } from '@angular/core';
+import { ColumnBase } from './column-base';
+/**
+ * @hidden
+ */
+export declare class ColumnsContainer {
+    private columns;
+    allColumns: QueryList<ColumnBase>;
+    leafColumns: QueryList<ColumnBase>;
+    lockedColumns: QueryList<ColumnBase>;
+    nonLockedColumns: QueryList<ColumnBase>;
+    lockedLeafColumns: QueryList<ColumnBase>;
+    nonLockedLeafColumns: QueryList<ColumnBase>;
+    totalLevels: number;
+    changes: EventEmitter<any>;
+    leafColumnsToRender: ColumnBase[];
+    lockedColumnsToRender: ColumnBase[];
+    nonLockedColumnsToRender: ColumnBase[];
+    hasFooter: boolean;
+    unlockedWidth: number;
+    constructor(columns: Function);
+    refresh(): boolean;
+}

package/dist/es2015/columns/columns-container.js

@@ -0,0 +1,91 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { QueryList, EventEmitter } from '@angular/core';
+import { isColumnGroupComponent } from './column-group.component';
+import { columnsToRender, someLeafColumn } from './column-common';
+const reset = (...lists) => {
+    let diff = false;
+    for (let idx = 0; idx < lists.length; idx++) {
+        const [list, columns] = lists[idx];
+        diff = diff || list.length !== columns.length;
+        list.reset(columns);
+    }
+    return diff;
+};
+const ɵ0 = reset;
+/**
+ * @hidden
+ */
+export class ColumnsContainer {
+    constructor(columns) {
+        this.columns = columns;
+        this.allColumns = new QueryList();
+        this.leafColumns = new QueryList();
+        this.lockedColumns = new QueryList();
+        this.nonLockedColumns = new QueryList();
+        this.lockedLeafColumns = new QueryList();
+        this.nonLockedLeafColumns = new QueryList();
+        this.totalLevels = 0;
+        this.changes = new EventEmitter();
+        this.leafColumnsToRender = [];
+        this.lockedColumnsToRender = [];
+        this.nonLockedColumnsToRender = [];
+        this.hasFooter = false;
+        this.unlockedWidth = 0;
+    }
+    refresh() {
+        const currentLevels = this.totalLevels;
+        const leafColumns = new Array();
+        const lockedLeafColumns = new Array();
+        const nonLockedLeafColumns = new Array();
+        const lockedColumns = new Array();
+        const nonLockedColumns = new Array();
+        const allColumns = new Array();
+        const leafColumnsToRender = new Array();
+        const lockedColumnsToRender = new Array();
+        const nonLockedColumnsToRender = new Array();
+        let hasFooter = false;
+        let unlockedWidth = 0;
+        let leafIndex = 0;
+        this.totalLevels = 0;
+        this.columns().forEach(column => {
+            const containerLeafColumns = column.isLocked === true ? lockedLeafColumns : nonLockedLeafColumns;
+            const containerColumns = column.isLocked === true ? lockedColumns : nonLockedColumns;
+            const toRenderContainer = column.isLocked === true ? lockedColumnsToRender : nonLockedColumnsToRender;
+            if (!isColumnGroupComponent(column)) {
+                containerLeafColumns.push(column);
+                leafColumns.push(column);
+                leafColumnsToRender.push.apply(leafColumnsToRender, columnsToRender([column]));
+                toRenderContainer.push.apply(toRenderContainer, columnsToRender([column]));
+                hasFooter = hasFooter || someLeafColumn(leaf => Boolean(leaf.footerTemplateRef), column);
+                if (!column.isLocked) {
+                    unlockedWidth += column.width || 0;
+                }
+                if (column.isSpanColumn) {
+                    column.childColumns.forEach(c => {
+                        c.leafIndex = leafIndex++;
+                    });
+                }
+                else {
+                    column.leafIndex = leafIndex++;
+                }
+            }
+            containerColumns.push(column);
+            allColumns.push(column);
+            this.totalLevels = column.level > this.totalLevels ? column.level : this.totalLevels;
+        });
+        this.hasFooter = hasFooter;
+        this.leafColumnsToRender = leafColumnsToRender;
+        this.lockedColumnsToRender = lockedColumnsToRender;
+        this.nonLockedColumnsToRender = nonLockedColumnsToRender;
+        this.unlockedWidth = unlockedWidth;
+        const changes = reset([this.leafColumns, leafColumns], [this.lockedLeafColumns, lockedLeafColumns], [this.nonLockedLeafColumns, nonLockedLeafColumns], [this.lockedColumns, lockedColumns], [this.allColumns, allColumns], [this.nonLockedColumns, nonLockedColumns]) || currentLevels !== this.totalLevels;
+        if (changes) {
+            this.changes.emit();
+        }
+        return changes;
+    }
+}
+export { ɵ0 };

package/dist/es2015/columns/command-column.component.d.ts

@@ -0,0 +1,42 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { TemplateRef } from '@angular/core';
+import { ColumnBase } from './column-base';
+import { CellTemplateDirective } from '../rendering/cell-template.directive';
+import { OptionChangesService } from '../common/option-changes.service';
+/**
+ * Represents the command columns of the TreeList. You have to define the content of the
+ * column inside an `<ng-template>` tag. The template context is set to the current
+ * data item. For more information and examples on using the passed fields
+ * and the command directives, refer to the article on
+ * [editing the TreeList in Angular Reactive Forms]({% slug editing_reactive_forms_treelist %}).
+ *
+ * The following additional fields are passed:
+ * - `columnIndex`&mdash;The current column index.
+ * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
+ * - `dataItem`&mdash;The current data item.
+ * - `column`&mdash;The current column instance.
+ * - `isNew`&mdash;The state of the current item.
+ *
+ * Usually, the template contains CRUD command directives such as:
+ * - [`EditCommandDirective`]({% slug api_treelist_editcommanddirective %})
+ * - [`RemoveCommandDirective`]({% slug api_treelist_removecommanddirective %})
+ * - [`CancelCommandDirective`]({% slug api_treelist_cancelcommanddirective %})
+ * - [`SaveCommandDirective`]({% slug api_treelist_savecommanddirective %})
+ *
+ * {% meta height:590 %}
+ * {% embed_file editing/editing-directives/reactive-editing/app.component.ts preview %}
+ * {% embed_file shared/employees.ts %}
+ * {% embed_file editing/editing-directives/reactive-editing/app.module.ts %}
+ * {% embed_file shared/main.ts %}
+ * {% endmeta %}
+ */
+export declare class CommandColumnComponent extends ColumnBase {
+    parent?: ColumnBase;
+    template: CellTemplateDirective;
+    isCommand: boolean;
+    constructor(parent?: ColumnBase, optionChanges?: OptionChangesService);
+    readonly templateRef: TemplateRef<any>;
+}

package/dist/es2015/columns/command-column.component.js

@@ -0,0 +1,66 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+var CommandColumnComponent_1;
+import { Component, forwardRef, ContentChild, SkipSelf, Host, Optional } from '@angular/core';
+import { ColumnBase } from './column-base';
+import { CellTemplateDirective } from '../rendering/cell-template.directive';
+import { OptionChangesService } from '../common/option-changes.service';
+/**
+ * Represents the command columns of the TreeList. You have to define the content of the
+ * column inside an `<ng-template>` tag. The template context is set to the current
+ * data item. For more information and examples on using the passed fields
+ * and the command directives, refer to the article on
+ * [editing the TreeList in Angular Reactive Forms]({% slug editing_reactive_forms_treelist %}).
+ *
+ * The following additional fields are passed:
+ * - `columnIndex`&mdash;The current column index.
+ * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
+ * - `dataItem`&mdash;The current data item.
+ * - `column`&mdash;The current column instance.
+ * - `isNew`&mdash;The state of the current item.
+ *
+ * Usually, the template contains CRUD command directives such as:
+ * - [`EditCommandDirective`]({% slug api_treelist_editcommanddirective %})
+ * - [`RemoveCommandDirective`]({% slug api_treelist_removecommanddirective %})
+ * - [`CancelCommandDirective`]({% slug api_treelist_cancelcommanddirective %})
+ * - [`SaveCommandDirective`]({% slug api_treelist_savecommanddirective %})
+ *
+ * {% meta height:590 %}
+ * {% embed_file editing/editing-directives/reactive-editing/app.component.ts preview %}
+ * {% embed_file shared/employees.ts %}
+ * {% embed_file editing/editing-directives/reactive-editing/app.module.ts %}
+ * {% embed_file shared/main.ts %}
+ * {% endmeta %}
+ */
+let CommandColumnComponent = CommandColumnComponent_1 = class CommandColumnComponent extends ColumnBase {
+    constructor(parent, optionChanges) {
+        super(parent, optionChanges);
+        this.parent = parent;
+        this.isCommand = true;
+    }
+    get templateRef() {
+        return this.template ? this.template.templateRef : undefined;
+    }
+};
+tslib_1.__decorate([
+    ContentChild(CellTemplateDirective, { static: false }),
+    tslib_1.__metadata("design:type", CellTemplateDirective)
+], CommandColumnComponent.prototype, "template", void 0);
+CommandColumnComponent = CommandColumnComponent_1 = tslib_1.__decorate([
+    Component({
+        providers: [
+            {
+                provide: ColumnBase,
+                useExisting: forwardRef(() => CommandColumnComponent_1)
+            }
+        ],
+        selector: 'kendo-treelist-command-column',
+        template: ``
+    }),
+    tslib_1.__param(0, SkipSelf()), tslib_1.__param(0, Host()), tslib_1.__param(0, Optional()),
+    tslib_1.__metadata("design:paramtypes", [ColumnBase, OptionChangesService])
+], CommandColumnComponent);
+export { CommandColumnComponent };

package/dist/es2015/columns/sort-settings.d.ts

@@ -0,0 +1,107 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Defines the settings for sorting the TreeList column.
+ */
+export declare type ColumnSortSettings = boolean | {
+    /**
+     * Enables the removal of the column sorting.
+     */
+    allowUnsort?: boolean;
+    /**
+     * Determines the initial (from the unsorted to the sorted state) sort direction.
+     *
+     * The available values for setting the initial sort direction are:
+     * - `asc` (default)
+     * - `desc`
+     */
+    initialDirection?: 'asc' | 'desc';
+};
+/**
+ * Defines the settings for sorting the TreeList.
+ */
+export declare type SortSettings = boolean | ColumnSortSettings & {
+    /**
+     * The sort mode of the TreeList.
+     *
+     * The available values for setting the sort modes are:
+     * - `single`
+     * - `multiple`
+     */
+    mode?: 'single' | 'multiple';
+    /**
+     * Enables the sort-sequence indicators for sorting multiple columns.
+     */
+    showIndexes?: boolean;
+};
+/**
+ * @hidden
+ */
+export declare const normalize: (...settings: (boolean | {
+    /**
+     * Enables the removal of the column sorting.
+     */
+    allowUnsort?: boolean;
+    /**
+     * Determines the initial (from the unsorted to the sorted state) sort direction.
+     *
+     * The available values for setting the initial sort direction are:
+     * - `asc` (default)
+     * - `desc`
+     */
+    initialDirection?: "desc" | "asc";
+} | (false & {
+    /**
+     * The sort mode of the TreeList.
+     *
+     * The available values for setting the sort modes are:
+     * - `single`
+     * - `multiple`
+     */
+    mode?: "single" | "multiple";
+    /**
+     * Enables the sort-sequence indicators for sorting multiple columns.
+     */
+    showIndexes?: boolean;
+}) | (true & {
+    /**
+     * The sort mode of the TreeList.
+     *
+     * The available values for setting the sort modes are:
+     * - `single`
+     * - `multiple`
+     */
+    mode?: "single" | "multiple";
+    /**
+     * Enables the sort-sequence indicators for sorting multiple columns.
+     */
+    showIndexes?: boolean;
+}) | ({
+    /**
+     * Enables the removal of the column sorting.
+     */
+    allowUnsort?: boolean;
+    /**
+     * Determines the initial (from the unsorted to the sorted state) sort direction.
+     *
+     * The available values for setting the initial sort direction are:
+     * - `asc` (default)
+     * - `desc`
+     */
+    initialDirection?: "desc" | "asc";
+} & {
+    /**
+     * The sort mode of the TreeList.
+     *
+     * The available values for setting the sort modes are:
+     * - `single`
+     * - `multiple`
+     */
+    mode?: "single" | "multiple";
+    /**
+     * Enables the sort-sequence indicators for sorting multiple columns.
+     */
+    showIndexes?: boolean;
+}))[]) => any;

package/dist/es2015/columns/sort-settings.js

@@ -0,0 +1,17 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ */
+const DEFAULTS = {
+    allowUnsort: true,
+    mode: 'single',
+    showIndexes: true,
+    initialDirection: 'asc'
+};
+/**
+ * @hidden
+ */
+export const normalize = (...settings) => Object.assign({}, DEFAULTS, ...settings);