Skip to content

refactor(footer): use signals and protect internals #343

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(footer): use signals and protect internals #343

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
7 changes: 3 additions & 4 deletions projects/ngx-datatable/src/lib/components/footer/footer.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Component, DebugElement, TemplateRef, ViewChild } from '@angular/core';
import { Component, DebugElement, Signal, TemplateRef, viewChild } from '@angular/core';
import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
import { By } from '@angular/platform-browser';

Expand Down Expand Up @@ -254,7 +254,7 @@ class TestFixtureComponent {
pagerPreviousIcon = '';
pagerNextIcon = '';
totalMessage = '';
footerTemplate?: { template: TemplateRef<any> };
footerTemplate?: { template: Signal<TemplateRef<any>> };
selectedCount = 0;
selectedMessage?: string;

Expand All @@ -263,8 +263,7 @@ class TestFixtureComponent {
* selectively be passed to the DatatableFooterComponent
* in these unit tests
*/
@ViewChild('testTemplate', { read: TemplateRef, static: true })
testTemplate!: TemplateRef<any>;
readonly testTemplate = viewChild.required('testTemplate', { read: TemplateRef });

onPageEvent() {
return;
Expand Down
11 changes: 6 additions & 5 deletions projects/ngx-datatable/src/lib/components/footer/footer.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ import { DataTablePagerComponent } from './pager.component';
[ngClass]="{ 'selected-count': selectedMessage() }"
[style.height.px]="footerHeight()"
>
@if (footerTemplate()?.template) {
@let footerTemplate = this.footerTemplate()?.template();
@if (footerTemplate) {
<ng-template
[ngTemplateOutlet]="footerTemplate()!.template!"
[ngTemplateOutlet]="footerTemplate"
[ngTemplateOutletContext]="templateContext()"
/>
} @else {
Expand Down Expand Up @@ -64,9 +65,9 @@ export class DataTableFooterComponent {

readonly page = output<PagerPageEvent>();

readonly isVisible = computed(() => this.rowCount() / this.pageSize() > 1);
readonly curPage = computed(() => this.offset() + 1);
readonly templateContext: Signal<FooterContext> = computed(() => ({
protected readonly isVisible = computed(() => this.rowCount() / this.pageSize() > 1);
protected readonly curPage = computed(() => this.offset() + 1);
protected readonly templateContext: Signal<FooterContext> = computed(() => ({
rowCount: this.rowCount(),
pageSize: this.pageSize(),
selectedCount: this.selectedCount(),
Expand Down
16 changes: 8 additions & 8 deletions projects/ngx-datatable/src/lib/components/footer/footer.directive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ContentChild, Directive, Input, TemplateRef } from '@angular/core';
import { Directive, TemplateRef, input, contentChild, computed } from '@angular/core';

import { FooterContext } from '../../types/public.types';
import { DataTableFooterTemplateDirective } from './footer-template.directive';
Expand All @@ -7,13 +7,13 @@ import { DataTableFooterTemplateDirective } from './footer-template.directive';
selector: 'ngx-datatable-footer'
})
export class DatatableFooterDirective {
@Input('template')
_templateInput?: TemplateRef<FooterContext>;
readonly _templateInput = input<TemplateRef<FooterContext>>(undefined, { alias: 'template' });

@ContentChild(DataTableFooterTemplateDirective, { read: TemplateRef })
_templateQuery?: TemplateRef<FooterContext>;
private readonly _templateQuery = contentChild(DataTableFooterTemplateDirective, {
read: TemplateRef
});

get template(): TemplateRef<FooterContext> | undefined {
return this._templateInput ?? this._templateQuery;
}
readonly template = computed(() => {
return this._templateInput() ?? this._templateQuery();
});
}
Loading