Skip to content
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

Jump to bottom

feat(grid): expose column input for template context #9694

Merged
merged 12 commits into from
Jul 2, 2021
Merged

feat(grid): expose column input for template context #9694

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c9c98fe
feat(grid): expose column input for template context
dobromirts Jun 10, 2021
565bcfb
Merge branch 'master' into dTsvetkov/feat-9020-master
hanastasov Jun 10, 2021
882d925
chore(*): add test for templateContext input
dobromirts Jun 10, 2021
e3402a7
Merge branch 'dTsvetkov/feat-9020-master' of https://github.com/Ignit…
dobromirts Jun 10, 2021
2467668
Merge branch 'master' into dTsvetkov/feat-9020-master
zdrawku Jun 21, 2021
5aaa9af
Merge branch 'master' into dTsvetkov/feat-9020-master
zdrawku Jun 24, 2021
e533840
Merge branch 'master' into dTsvetkov/feat-9020-master
zdrawku Jun 28, 2021
c5fd984
chore(*): add template binding
dobromirts Jun 29, 2021
872d745
chore(*): remove redundant property
dobromirts Jun 30, 2021
25772e1
chore(*): update additionalTemplateContext example
dobromirts Jun 30, 2021
cdc41c7
Merge branch 'master' into dTsvetkov/feat-9020-master
rkaraivanov Jun 30, 2021
f7d59c9
Merge branch 'master' into dTsvetkov/feat-9020-master
zdrawku Jul 2, 2021
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
32 changes: 32 additions & 0 deletions projects/igniteui-angular/src/lib/grids/columns/column.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -915,6 +915,37 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
}
}

/**
* Sets custom properties provided in additional template context.
*
* ```html
* <igx-column [templateContext]="contextObject">
* <ng-template igxCell let-cell="cell">
* {{ cell.column.contextObject.prop }}
* </ng-template>
* </igx-column>
* ```
*
* @memberof IgxColumnComponent
*/
@Input()
public set templateContext(value: any){
this._contextObject = value;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. templateContext suggests that the use can overwrite the context object in the column templates making it a little dubious.
    Maybe additionalTemplateContext or something along these lines.

  2. I don't think you need to separate it between a setter and a getter. Just leave it as simple property on the class.

  3. It will be nice to access the additional context directly from the template binding:

<ng-template igxCell let-props="additionalContext">
...
</ng-template>

}

/**
* Gets the column `contextObject`.
* ```typescript
* let columncontextObject = this.column.contextObject;
* ```
*
* @memberof IgxColumnComponent
*/
public get contextObject(): any {
return this._contextObject;
}


/**
* Gets the column `summaries`.
* ```typescript
Expand Down Expand Up @@ -1567,6 +1598,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
private _field: string;
private _calcWidth = null;
private _columnPipeArgs: IColumnPipeArgs = { digitsInfo: DEFAULT_DIGITS_INFO };
private _contextObject: any;

constructor(
public gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>,
Expand Down
40 changes: 40 additions & 0 deletions projects/igniteui-angular/src/lib/grids/grid/column.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ describe('IgxGrid - Column properties #grid', () => {
ColumnsFromIterableComponent,
TemplatedColumnsComponent,
TemplatedInputColumnsComponent,
TemplatedContextInputColumnsComponent,
ColumnCellFormatterComponent,
ColumnHaederClassesComponent,
ColumnHiddenFromMarkupComponent,
Expand Down Expand Up @@ -308,6 +309,20 @@ describe('IgxGrid - Column properties #grid', () => {

});

it('should support passing properties through the templateContext input property', () => {
const fixture = TestBed.createComponent(TemplatedContextInputColumnsComponent);
fixture.detectChanges();

const grid = fixture.componentInstance.instance;
const contextObject = {property1: 'cellContent', property2: 'header'};
const firstColumn = grid.columns[0];
const secondColumn = grid.getColumnByName('LastName');

expect(firstColumn.contextObject).toEqual(contextObject);
expect(firstColumn.cells[0].nativeElement.innerText).toEqual(contextObject.property1);
expect(secondColumn.headerCell.elementRef.nativeElement.innerText).toEqual(contextObject.property2);
});

it('should apply column\'s formatter programmatically', () => {
const expectedVal = ['Johny', 'Sally', 'Tim'];
const expectedValToLower = ['johny', 'sally', 'tim'];
Expand Down Expand Up @@ -1133,6 +1148,31 @@ export class TemplatedInputColumnsComponent {
public columns = Object.keys(this.data[0]);
}


@Component({
template: `
<igx-grid [data]="data">
<igx-column [templateContext]="contextObject" field="FirstName">
<ng-template igxCell let-cell="cell">
{{ cell.column.contextObject.property1 }}
</ng-template>
</igx-column>
<igx-column [templateContext]="contextObject" field="LastName">
<ng-template igxHeader let-column>
{{ column.contextObject.property2 }}
</ng-template>
</igx-column>
</igx-grid>
`
})
export class TemplatedContextInputColumnsComponent {
@ViewChild(IgxGridComponent, { read: IgxGridComponent, static: true })
public instance: IgxGridComponent;
public contextObject = {property1: 'cellContent', property2: 'header'};

public data = SampleTestData.personNameAgeData();
}

@Component({
template: `
<igx-grid [data]="data" height="500px" width="400px">
Expand Down