Skip to content

docs(table): add example using http #5766

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.

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 11 commits into from
Jul 20, 2017
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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: 7 additions & 0 deletions src/material-examples/example-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ import {PizzaPartyComponent,SnackBarComponentExample} from './snack-bar-componen
import {SnackBarOverviewExample} from './snack-bar-overview/snack-bar-overview-example';
import {SortOverviewExample} from './sort-overview/sort-overview-example';
import {TableBasicExample} from './table-basic/table-basic-example';
import {TableHttpExample} from './table-http/table-http-example';
import {TableFilteringExample} from './table-filtering/table-filtering-example';
import {TableOverviewExample} from './table-overview/table-overview-example';
import {TablePaginationExample} from './table-pagination/table-pagination-example';
Expand Down Expand Up @@ -417,6 +418,12 @@ export const EXAMPLE_COMPONENTS = {
additionalFiles: null,
selectorName: null
},
'table-http': {
title: 'Table retrieving data through HTTP',
component: TableHttpExample,
additionalFiles: null,
selectorName: null
},
'table-filtering': {
title: 'Table with filtering',
component: TableFilteringExample,
Expand Down
33 changes: 33 additions & 0 deletions src/material-examples/table-http/table-http-example.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/* Structure */
.example-container {
display: flex;
flex-direction: column;
max-height: 500px;
min-width: 300px;
}

.example-header {
min-height: 64px;
display: flex;
align-items: center;
padding-left: 24px;
font-size: 20px;
}

.mat-table {
Copy link
Member

Choose a reason for hiding this comment

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

All these classes need to be under an .example- prefix

overflow: auto;
}

.mat-column-title {
text-overflow: ellipsis;
white-space: nowrap;
flex: 1;
overflow: hidden;
}

/* Column Widths */
.mat-column-number,
.mat-column-state,
.mat-column-commentCount {
max-width: 64px;
}
28 changes: 28 additions & 0 deletions src/material-examples/table-http/table-http-example.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<div class="example-container mat-elevation-z8">
<md-table #table [dataSource]="dataSource">

<!--- Note that these columns can be defined in any order.
The actual rendered columns are set as a property on the row definition" -->

<!-- Number Column -->
<ng-container cdkColumnDef="number">
<md-header-cell *cdkHeaderCellDef> Number </md-header-cell>
<md-cell *cdkCellDef="let row"> {{row.number}} </md-cell>
</ng-container>

<!-- Title Column -->
<ng-container cdkColumnDef="title">
<md-header-cell *cdkHeaderCellDef> Title </md-header-cell>
<md-cell *cdkCellDef="let row"> {{row.title}} </md-cell>
</ng-container>

<!-- State Column -->
<ng-container cdkColumnDef="state">
<md-header-cell *cdkHeaderCellDef> State </md-header-cell>
<md-cell *cdkCellDef="let row"> {{row.state}} </md-cell>
</ng-container>

<md-header-row *cdkHeaderRowDef="displayedColumns"></md-header-row>
<md-row *cdkRowDef="let row; columns: displayedColumns;"></md-row>
</md-table>
</div>
70 changes: 70 additions & 0 deletions src/material-examples/table-http/table-http-example.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import {Component} from '@angular/core';
import {Http, Response} from '@angular/http';
import {DataSource} from '@angular/cdk';
import {Observable} from 'rxjs/Observable';
import 'rxjs/add/operator/startWith';
import 'rxjs/add/observable/merge';
import 'rxjs/add/operator/map';

@Component({
selector: 'table-http-example',
styleUrls: ['table-http-example.css'],
templateUrl: 'table-http-example.html',
})
export class TableHttpExample {
displayedColumns = ['number', 'state', 'title'];
exampleDatabase: ExampleHttpDao | null;
dataSource: ExampleDataSource | null;

constructor(http: Http) {
this.exampleDatabase = new ExampleHttpDao(http);
this.dataSource = new ExampleDataSource(this.exampleDatabase);
}
}

export interface GithubIssue {
number: string;
state: string;
title: string;
}

/** An example database that the data source uses to retrieve data for the table. */
export class ExampleHttpDao {
Copy link
Member

Choose a reason for hiding this comment

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

I think we should include sorting and pagination in this example. The github api supports it.

private issuesUrl = 'https://api.github.com/repos/angular/material2/issues'; // URL to web API

constructor(private http: Http) {}

getRepoIssues(): Observable<GithubIssue[]> {
return this.http.get(this.issuesUrl).map(this.readGithubResult);
}

private readGithubResult(result: Response): GithubIssue[] {
return result.json().map(issue => {
return {
number: issue.number,
state: issue.state,
title: issue.title,
};
});
}
}

/**
* Data source to provide what data should be rendered in the table. Note that the data source
* can retrieve its data in any way. In this case, the data source is provided a reference
* to a common data base, ExampleHttpDao. It is not the data source's responsibility to manage
* the underlying data. Instead, it only needs to take the data and send the table exactly what
* should be rendered.
*/
export class ExampleDataSource extends DataSource<GithubIssue> {
constructor(private _exampleDatabase: ExampleHttpDao) {
super();
}

/** Connect function called by the table to retrieve one stream containing the data to render. */
connect(): Observable<GithubIssue[]> {
return this._exampleDatabase.getRepoIssues();
}

disconnect() {}
}