Многоразовый компонент angular 4 и шаблон

Я застрял в создании повторно используемого компонента в Angular 4. У меня есть куча отчетов, которые состоят из формы поиска (поля разные для каждого отчета) и списка результатов таблицы материалов (список полей отличается для каждого отчета). Он работает, как и ожидалось, когда я дублирую весь компонент для каждого отчета, но я хочу реорганизовать его в повторно используемый компонент/шаблон и дочерние компоненты, расширяющие его. Но все области неверны, и я не могу понять, как это работает.

report.component.ts (компонент многократного использования)

import {Component, ViewChild} from '@angular/core';
import {MatPaginator} from '@angular/material';

import 'rxjs/add/operator/map';

import {ReportsDataSource} from '../services/reports-datasource.service';

@Component({
    selector: 'app-report',
    templateUrl: './report.component.html',
})
export class ReportComponent {
    @ViewChild(MatPaginator) paginator: MatPaginator;

    /** result table columns */
    columns = [];

    /** Column definitions in order */
    displayedColumns = this.columns.map(x => x.columnDef);

    /** empty search parameters object, used for form field binding */

    /** datasource service */
    dataSource: ReportsDataSource;

    /** submit the form */
    getData() {
        this.dataSource.getData();
    }
}

report.component.html (шаблон многократного использования)

<form (ngSubmit)="getData()" #ReportSearchForm="ngForm">
    <ng-content select=".container-fluid"></ng-content>
    <button type="submit" mat-button class="mat-primary" [disabled]="!ReportSearchForm.form.valid">Search</button>
</form>
<mat-table #table [dataSource]="dataSource">
    <ng-container *ngFor="let column of columns" [matColumnDef]="column.columnDef">
        <mat-header-cell *matHeaderCellDef>{{ column.header }}</mat-header-cell>
        <mat-cell *matCellDef="let row">{{ column.cell(row) }}</mat-cell>
    </ng-container>
    <mat-header-row *matHeaderRowDef="displayedColumns"></mat-header-row>
    <mat-row *matRowDef="let row; columns: displayedColumns;"></mat-row>
</mat-table>
<mat-paginator #paginator
               [length]="dataSource ? dataSource.meta.total_results : 0"
               [pageSize]="dataSource ? dataSource.meta.per_page : 25"
               [pageSizeOptions]="[10, 25, 50, 100]"
>
</mat-paginator>

childreport.component.ts (конкретный отчет)

import {Component, OnInit} from '@angular/core';

import {ReportComponent} from '../report.component';
import {ChildreportService} from './childreport.service';
import {ReportsDataSource} from '../../services/reports-datasource.service';

@Component({
    selector: 'app-report-child',
    templateUrl: './childreport.component.html',
    providers: [ChildreportService, ReportsDataSource]
})
export class ChildreportComponent extends ReportComponent implements OnInit {
    constructor(private childreportService: ChildreportService) {
        super();
    }

    /** result table columns */
    columns = [
        {columnDef: 'column1', header: 'Label 1', cell: (row) => `${row.column1}`},
        {columnDef: 'column2', header: 'Label 2', cell: (row) => `${row.column2}`}
    ];

    ngOnInit() {
        this.dataSource = new ReportsDataSource(this.ChildreportService, this.paginator);
    }
}

childreport.component.html (форма поиска для этого отчета, встроенная в родительский шаблон)

<app-report>
    <div class="container-fluid">
        <mat-form-field>
            <input matInput placeholder="some field" name="fieldx">
        </mat-form-field>
    </div>
</app-report>

Что работает: я получаю форму, встроенную в основной шаблон, и никаких ошибок.

Что не работает: Форма и таблица привязаны к ReportComponent вместо ChildreportComponent. Я вроде как понимаю, почему это происходит (потому что областью этого шаблона является этот компонент), но я понятия не имею, как я могу «наследовать» шаблон и быть в области действия ChildreportComponent. Что мне не хватает?


person masterfloda    schedule 17.10.2017    source источник


Ответы (2)


Я понял это сам. На самом деле решение довольно тривиальное. Моя ошибка заключалась в том, что я попробовал две вещи одновременно в моем report.component, предоставив шаблон, а также логику. В итоге я получил абстрактный компонент, который содержит логику и расширяется каждым отчетом, а также несколько более мелких компонентов для аналогичных частей в каждом отчете (оболочка, список результатов и т. д.). Я также перешел с шаблонных форм на реактивные формы.

report-base.component.ts содержит общую логику

import {OnInit} from '@angular/core';
import {FormBuilder, FormGroup} from '@angular/forms';
import {MatPaginator, MatSidenav} from '@angular/material';

import 'rxjs/add/operator/map';

import {ReportsDataSource} from '../common/services/reports-datasource.service';
import {ReportsService} from '../common/services/reports.service';
import {ReportsResultlistService} from '../common/services/reports-resultlist.service';

export abstract class ReportBaseComponent implements OnInit {
    constructor(
        protected _formBuilder: FormBuilder, protected _reportService: ReportsService, protected _resultlistService: ReportsResultlistService) {
    }


    /**
     * For toggling the search form and resultlist action buttons
     * @type {boolean}
     */
    protected hasResults = false;

    /** Default data source for the table */
    protected dataSource: ReportsDataSource;

    /** search form controls */
    protected searchForm: FormGroup;

    /** result table columns */
    protected columns = [];

    ngOnInit() {
        this.createForm();
        this.dataSource = new ReportsDataSource(this._reportService, this._resultlistService);
    }

    /**
     * Builds the searchForm Group
     */
    protected createForm() {
        // create an empty form
        this.searchForm = this._formBuilder.group({});
    }

    /**
     * Submits the form/loads data (f.ex. pagination)
     */
    protected getData() {
        this.hasResults = true;
        this.dataSource.search = this.searchForm.value;
        this.dataSource.getData();
    }
}

report-shell.component.ts — это дочерний компонент (одна из моих логических ошибок), который обеспечивает оболочку вокруг компонентов:

import {Component, Input} from '@angular/core';
import {ActivatedRoute} from '@angular/router';

@Component({
    selector: 'app-report-shell',
    templateUrl: './report-shell.component.html',
})
export class ReportShellComponent {
    constructor(private route: ActivatedRoute) {
        this.title = route.routeConfig.data['caption'];
    }

    @Input() hasResults = false;
    title: string;
}

report-shell.component.html предоставляет HTML вокруг формы поиска и списка результатов.

<mat-expansion-panel [expanded]="!hasResults">
    <mat-expansion-panel-header>
        Search
    </mat-expansion-panel-header>
    <ng-content select="form"></ng-content>
</mat-expansion-panel>
<div class="result-list">
    <mat-toolbar class="result-header"><span>{{ title }}</span>
        <span class="fill-remaining-space"></span>
        <button class="fa fa-file-excel-o" (click)="exportExcel()"></button>
    </mat-toolbar>
    <ng-content select=".result-table"></ng-content>
</div>

Таким образом, мои отчеты расширяют базу отчетов и просто используют оболочку как дочерний элемент:

childreport.component.ts — это специальный отчет, который реализует только то, что специфично для этого отчета.

import {Component, OnInit} from '@angular/core';
import {FormBuilder, Validators} from '@angular/forms';

import {ReportChildreportService} from './childreport.service';
import {ReportsDataSource} from '../../common/services/reports-datasource.service';
import {ReportsResultlistService} from '../../common/services/reports-resultlist.service';

import {ReportBaseComponent} from '../report-base.component';


@Component({
    selector: 'app-report-dispatches',
    templateUrl: './dispatches.component.html',
    providers: [ReportChildreportService, ReportsResultlistService, ReportsDataSource]
})
export class ReportDispatchesComponent extends ReportBaseComponent implements OnInit {
    constructor(protected _reportService: ReportChildreportService, protected _formBuilder: FormBuilder, protected _resultlistService: ReportsResultlistService) {
        super(_formBuilder, _reportService, _resultlistService);
    }

    /** result table columns */
    columns = [
        {columnDef: 'name', header: 'Name', cell: (row) => `${row.name}`}
    ];

    createForm() {
        this.searchForm = this._formBuilder.group({
            name: ''
        });
    }
}

childreport.component.html

<app-report-shell [hasResults]="hasResults">
    <form (ngSubmit)="getData()" [formGroup]="searchForm" novalidate>
                    <mat-form-field>
                        <input matInput placeholder="search for a name" name="name" formControlName="name">
                        <mat-error>Invalid name</mat-error>
                    </mat-form-field>
                </div>
        </div>
        <app-form-buttons [status]="searchForm.status"></app-form-buttons>
    </form>
        <app-report-result-list
                [(dataSource)]="dataSource"
                [columns]="columns"
                [displayedColumns]="displayedColumns"
                class="result-table"
        ></app-report-result-list>    
</app-report-shell>

Я не буду вдаваться в детали форм и компонентов списка результатов, этот ответ и так достаточно длинный :-)

Таким образом, мне удалось значительно сократить повторение кода, хотя некоторые из них все еще есть (всегда в childreport.component.html, за исключением формы).

person masterfloda    schedule 27.10.2017

Я предлагаю вам взглянуть на эта статья. Декоратор @WjComponent может дать вам представление о вашем подходе. Из статьи я понял, что вам нужен новый декоратор компонентов для совместного использования свойств между базовым и дочерним классами.

Цитата из статьи:

@Component({  selector: 'inherited-grid'
})
export class InheritedGrid extends wjGrid.WjFlexGrid {
...
}

Теперь у нас есть новое имя элемента для нашего компонента! Но мы пропустили все остальные необходимые настройки, определенные в декораторе базового класса WjFlexGrid. Например, декоратор WjFlexGrid присваивает свойству декоратора inputs массив свойств сетки, доступных для привязок в разметке. Мы потеряли его в нашем новом компоненте, и если вы попытаетесь выполнить привязку к ним сейчас, вы обнаружите, что привязки не работают.

Ответ: декоратор @WjComponent, предлагаемый модулем Wijmo для Angular 2. Он используется так же, как и стандартный декоратор @Component, и принимает все свойства декоратора @Component (плюс некоторые специфичные для Wijmo), но его главное преимущество заключается в том, что он объединяет значения своих свойств со свойствами, предоставляемыми декоратором базового класса. Итак, последний шаг в определении нашего компонента — замена @Component на @WjComponent: import { WjComponent } from 'wijmo/wijmo.angular2.directiveBase';

@WjComponent({
  selector: 'inherited-grid'
})
export class InheritedGrid extends wjGrid.WjFlexGrid {
...
}

Возможно, мы переопределили свойство селектора декоратора с именем «inherited-grid», но все остальные необходимые свойства, такие как входы и выходы, были взяты из декоратора базового компонента WjFlexGrid. И теперь element создает наш компонент InheritedGrid со всеми правильно функционирующими привязками свойств и событий!


Другим подходом может быть определение ReportComponent как директивы и обмен данными между ChildReport и базой через декоратор @Host.

Вы также можете ознакомиться с исходным кодом ngx-datatable. Исходный код их примеров и компонентов очень информативен и может дать вам идеи о совместном использовании данных между компонентами и переопределении шаблонов.

person Halil İbrahim Karaalp    schedule 26.10.2017