Skip to content

Commit d2baacc

Browse files
crisbetojelbourn
authored andcommitted
docs(table): add note about MatTableDataSource usage (#16933)
Adds a note to the `MatTableDataSource` docs to be more explicit about what the intentions behind the data source are.
1 parent 6af0dfb commit d2baacc

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/material/table/table-data-source.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ const MAX_SAFE_INTEGER = 9007199254740991;
3434
* Allows for sort customization by overriding sortingDataAccessor, which defines how data
3535
* properties are accessed. Also allows for filter customization by overriding filterTermAccessor,
3636
* which defines how row data is converted to a string for filter matching.
37+
*
38+
* **Note:** This class is meant to be a simple data source to help you get started. As such
39+
* it isn't equipped to handle some more advanced cases like robust i18n support or server-side
40+
* interactions. If your app needs to support more advanced use cases, consider implementing your
41+
* own `DataSource`.
3742
*/
3843
export class MatTableDataSource<T> extends DataSource<T> {
3944
/** Stream that emits when a new data array is set on the data source. */

0 commit comments

Comments
 (0)