Skip to content

refactor: convert columns to signal input #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2025
Merged

refactor: convert columns to signal input #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions projects/ngx-datatable/src/lib/components/datatable.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[innerWidth]="_innerWidth"
[offsetX]="_offsetX"
[dealsWithGroup]="groupedRows !== undefined"
[columns]="_internalColumns"
[columns]="_internalColumns()"
[headerHeight]="headerHeight()"
[reorderable]="reorderable()"
[targetMarkerTemplate]="targetMarkerTemplate()"
Expand Down Expand Up @@ -46,7 +46,7 @@
[rowCount]="rowCount"
[offset]="offset"
[trackByProp]="trackByProp()"
[columns]="_internalColumns"
[columns]="_internalColumns()"
[pageSize]="pageSize"
[offsetX]="_offsetX"
[rowDetail]="rowDetail"
Expand Down
81 changes: 34 additions & 47 deletions projects/ngx-datatable/src/lib/components/datatable.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
Input,
IterableDiffer,
IterableDiffers,
linkedSignal,
model,
numberAttribute,
OnDestroy,
Expand Down Expand Up @@ -171,21 +172,7 @@ export class DatatableComponent<TRow extends Row = any>
/**
* Columns to be displayed.
*/
@Input() set columns(val: TableColumn[]) {
if (val) {
this._internalColumns = toInternalColumn(val, this._defaultColumnWidth);
this.recalculateColumns();
}

this._columns = val;
}

/**
* Get the columns.
*/
get columns(): TableColumn[] {
return this._columns;
}
readonly columns = input<TableColumn[]>();

/**
* List of row objects that should be
Expand Down Expand Up @@ -706,8 +693,18 @@ export class DatatableComponent<TRow extends Row = any>
_rows: (TRow | undefined)[] = [];
_groupRowsBy?: keyof TRow;
_internalRows: (TRow | undefined)[] = [];
_internalColumns!: TableColumnInternal<TRow>[];
_columns!: TableColumn[];
// TODO: consider removing internal modifications of the columns.
// This requires a different strategy for certain properties like width.
readonly _internalColumns = linkedSignal(() =>
this.recalculateColumns(
toInternalColumn(
this.columnTemplates().length
? this.columnTemplates().map(c => c.column())
: (this.columns() ?? []),
this._defaultColumnWidth
)
)
);
_subscriptions: Subscription[] = [];
_defaultColumnWidth = this.configuration?.defaultColumnWidth ?? 150;
/**
Expand Down Expand Up @@ -750,7 +747,7 @@ export class DatatableComponent<TRow extends Row = any>
this.limit();
this.count();
// Recalculate without tracking other signals
untracked(() => this.recalculate());
untracked(() => this.recalculateDims());
});
}

Expand All @@ -772,7 +769,11 @@ export class DatatableComponent<TRow extends Row = any>
const rowDiffers = this.rowDiffer.diff(this.rows);
if (rowDiffers || this.disableRowCheck()) {
// we don't sort again when ghost loader adds a dummy row
if (!this.ghostLoadingIndicator() && !this.externalSorting() && this._internalColumns) {
if (
!this.ghostLoadingIndicator() &&
!this.externalSorting() &&
this._internalColumns().length
) {
this.sortInternalRows();
} else {
this._internalRows = [...this.rows];
Expand Down Expand Up @@ -850,8 +851,6 @@ export class DatatableComponent<TRow extends Row = any>
*/
translateColumns(columns: TableColumn<TRow>[]) {
if (columns.length) {
this._internalColumns = toInternalColumn(columns, this._defaultColumnWidth);
this.recalculateColumns();
if (!this.externalSorting() && this.rows?.length) {
this.sortInternalRows();
}
Expand Down Expand Up @@ -905,7 +904,7 @@ export class DatatableComponent<TRow extends Row = any>
*/
recalculate(): void {
this.recalculateDims();
this.recalculateColumns();
this._internalColumns.set(this.recalculateColumns(this._internalColumns().slice()));
this.cd.markForCheck();
}

Expand All @@ -923,13 +922,13 @@ export class DatatableComponent<TRow extends Row = any>
* distribution mode and scrollbar offsets.
*/
recalculateColumns(
columns: TableColumnInternal[] = this._internalColumns,
columns: TableColumnInternal[],
forceIdx = -1,
allowBleed: boolean = this.scrollbarH()
): TableColumn[] | undefined {
): TableColumnInternal[] {
let width = this._innerWidth;
if (!columns || !width) {
return undefined;
if (!width) {
return [];
}
const bodyElement = this.bodyElement?.nativeElement;
this.verticalScrollVisible = bodyElement?.scrollHeight > bodyElement?.clientHeight;
Expand All @@ -952,17 +951,6 @@ export class DatatableComponent<TRow extends Row = any>
adjustColumnWidths(columns, width);
}

// The type of width is wrong here.
// It can also be undefined, thus the eslint-rule must be disabled.
if (this.bodyComponent && this.bodyComponent.columnGroupWidths().total !== width) {
this._internalColumns = [...this._internalColumns];
this.bodyComponent.cd.markForCheck();
}

if (this.headerComponent && this.headerComponent._columnGroupWidths().total !== width) {
this._internalColumns = [...this._internalColumns];
}

return columns;
}

Expand Down Expand Up @@ -1119,14 +1107,13 @@ export class DatatableComponent<TRow extends Row = any>
return;
}

const idx = this._internalColumns.indexOf(column);
const cols = this._internalColumns.map(col => ({ ...col }));
const idx = this._internalColumns().indexOf(column);
const cols = this._internalColumns().map(col => ({ ...col }));
cols[idx].width = newValue;
// set this so we can force the column
// width distribution to be to this value
cols[idx].$$oldWidth = newValue;
this.recalculateColumns(cols, idx);
this._internalColumns = cols;
this._internalColumns.set(this.recalculateColumns(cols, idx));

this.resize.emit({
column,
Expand All @@ -1141,16 +1128,16 @@ export class DatatableComponent<TRow extends Row = any>
}
column.width = newValue;
column.$$oldWidth = newValue;
const idx = this._internalColumns.indexOf(column);
this.recalculateColumns(this._internalColumns, idx);
const idx = this._internalColumns().indexOf(column);
this._internalColumns.set(this.recalculateColumns(this._internalColumns().slice(), idx));
}

/**
* The header triggered a column re-order event.
*/
onColumnReorder(event: ReorderEventInternal): void {
const { column, newValue, prevValue } = event;
const cols = this._internalColumns.map(c => ({ ...c }));
const cols = this._internalColumns().map(c => ({ ...c }));
const prevCol = cols[newValue];
if (column.frozenLeft !== prevCol.frozenLeft || column.frozenRight !== prevCol.frozenRight) {
return;
Expand All @@ -1175,7 +1162,7 @@ export class DatatableComponent<TRow extends Row = any>
}
}

this._internalColumns = cols;
this._internalColumns.set(cols);

this.reorder.emit(event);
}
Expand Down Expand Up @@ -1305,13 +1292,13 @@ export class DatatableComponent<TRow extends Row = any>
this.groupedRows = this.groupArrayBy(this._rows, this._groupRowsBy!);
this.groupedRows = sortGroupedRows(
this.groupedRows,
this._internalColumns,
this._internalColumns(),
this.sorts(),
sortOnGroupHeader
);
this._internalRows = [...this._internalRows];
} else {
this._internalRows = sortRows(this._internalRows, this._internalColumns, this.sorts());
this._internalRows = sortRows(this._internalRows, this._internalColumns(), this.sorts());
}
}
}
Loading