@progress/kendo-angular-treelist
Version:
Kendo UI TreeList for Angular - Display hierarchical data in an Angular tree grid view that supports sorting, filtering, paging, and much more.
202 lines (201 loc) • 7.23 kB
JavaScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { forwardRef, Component, SkipSelf, Host, Optional, QueryList, ContentChildren, Input } from '@angular/core';
import { CellTemplateDirective } from '../rendering/cell-template.directive';
import { EditTemplateDirective } from '../editing/edit-template.directive';
import { ColumnBase } from './column-base';
import { ColumnComponent } from "./column.component";
import { isPresent } from "../utils";
import { OptionChangesService } from '../common/option-changes.service';
import * as i0 from "@angular/core";
import * as i1 from "./column-base";
import * as i2 from "../common/option-changes.service";
/**
* @hidden
*/
export function isSpanColumnComponent(column) {
return column.isSpanColumn;
}
/**
* Represents a column that spans multiple data cells while keeping individual header and footer cells.
* Use this component to create flexible layouts and retain built-in UI for [sorting]({% slug sorting_treelist %}) and [filtering]({% slug filtering_treelist %}).
* Wrap the columns to merge inside the `<kendo-treelist-span-column>` tag.
*
* @example
* ```html
* <kendo-treelist-span-column>
* <kendo-treelist-column field="field1"></kendo-treelist-column>
* <kendo-treelist-column field="field2"></kendo-treelist-column>
* <ng-template kendoTreeListCellTemplate let-dataItem>
* <h5>{{ dataItem.field1 }}</h5>
* <p>{{ dataItem.field2 }}</p>
* </ng-template>
* </kendo-treelist-span-column>
* ```
*/
export class SpanColumnComponent extends ColumnBase {
/**
* Specifies if the expanded indicator appears in the column.
*/
expandable;
/*
* @hidden
*/
isSpanColumn = true;
/**
* @hidden
*/
title;
/**
* @hidden
*/
headerClass;
/**
* @hidden
*/
footerClass;
/**
* @hidden
*/
headerStyle;
/**
* @hidden
*/
footerStyle;
template = new QueryList();
editTemplate = new QueryList();
/**
* @hidden
*/
childColumns = new QueryList();
/**
* @hidden
*/
includeInChooser = false;
/**
* Defines whether the edit template of the column is rendered.
* To enable editing for a spanned column, set an edit template for it.
* @default false
*/
set editable(value) {
this._editable = value;
}
get editable() {
return isPresent(this.editTemplateRef) && this._editable;
}
/**
* @hidden
* added for backwards compitability
*/
set width(_value) {
}
get width() {
return this.childColumns.reduce((total, column) => total + column.width, 0);
}
/**
* @hidden
*/
get leafIndex() {
return this.childColumns.first.leafIndex;
}
_editable = true;
constructor(parent, optionChanges) {
super(parent, optionChanges);
if (parent && parent.isSpanColumn) {
throw new Error('SpanColumn cannot be nested inside another SpanColumn');
}
}
/**
* @hidden
*/
get templateRef() {
const template = this.template.first;
return template ? template.templateRef : undefined;
}
/**
* @hidden
*/
get editTemplateRef() {
const editTemplate = this.editTemplate.first;
return editTemplate ? editTemplate.templateRef : undefined;
}
/**
* @hidden
*/
get colspan() {
return this.childColumns.filter(c => c.isVisible).length;
}
/**
* Toggles the locked (frozen) state of the columns. Locked columns are visible at all times during horizontal scrolling. [See example](slug:locked_columns_treelist).
* @default false
*/
set locked(value) {
this._locked = value;
}
get locked() {
return this._locked || this.childColumns.some(c => c.locked);
}
get isEditable() {
return Boolean(this.editTemplateRef);
}
get childrenArray() {
return this.childColumns.toArray();
}
get hasChildren() {
return this.childColumns.length > 0;
}
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.14", ngImport: i0, type: SpanColumnComponent, deps: [{ token: i1.ColumnBase, host: true, optional: true, skipSelf: true }, { token: i2.OptionChangesService }], target: i0.ɵɵFactoryTarget.Component });
static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "18.2.14", type: SpanColumnComponent, isStandalone: true, selector: "kendo-treelist-span-column", inputs: { expandable: "expandable", title: "title", headerClass: "headerClass", footerClass: "footerClass", headerStyle: "headerStyle", footerStyle: "footerStyle", editable: "editable", locked: "locked" }, providers: [
{
provide: ColumnBase,
useExisting: forwardRef(() => SpanColumnComponent)
}
], queries: [{ propertyName: "template", predicate: CellTemplateDirective }, { propertyName: "editTemplate", predicate: EditTemplateDirective }, { propertyName: "childColumns", predicate: ColumnComponent }], usesInheritance: true, ngImport: i0, template: ``, isInline: true });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.14", ngImport: i0, type: SpanColumnComponent, decorators: [{
type: Component,
args: [{
providers: [
{
provide: ColumnBase,
useExisting: forwardRef(() => SpanColumnComponent)
}
],
selector: 'kendo-treelist-span-column',
template: ``,
standalone: true
}]
}], ctorParameters: () => [{ type: i1.ColumnBase, decorators: [{
type: SkipSelf
}, {
type: Host
}, {
type: Optional
}] }, { type: i2.OptionChangesService }], propDecorators: { expandable: [{
type: Input
}], title: [{
type: Input
}], headerClass: [{
type: Input
}], footerClass: [{
type: Input
}], headerStyle: [{
type: Input
}], footerStyle: [{
type: Input
}], template: [{
type: ContentChildren,
args: [CellTemplateDirective, { descendants: false }]
}], editTemplate: [{
type: ContentChildren,
args: [EditTemplateDirective, { descendants: false }]
}], childColumns: [{
type: ContentChildren,
args: [ColumnComponent]
}], editable: [{
type: Input
}], locked: [{
type: Input
}] } });