From 9690fc1ae038cd9ba457982e8e7d15aa98171d6b Mon Sep 17 00:00:00 2001 From: Billy Pham Date: Mon, 4 Dec 2017 16:01:57 -0800 Subject: [PATCH 1/5] Add migration guide to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index dc38a3227..56c379589 100644 --- a/README.md +++ b/README.md @@ -117,3 +117,11 @@ By default Ember table cell renderes simple text defined inside each `column`. T width: 180 } ``` +## Migrating from old Ember table +To support smooth migration from old version of Ember table (support only till ember 1.11), we have move the old source code to separate package [ember-table-legacy](https://github.com/Addepar/ember-table-legacy). It's a separate package from this Ember table package and you can install it using yarn or npm. This allows you to have 2 versions of ember table in your code base and you can start your migrating one table at at time. The recommended migration steps is as follow (if you are using ember 1.11): + +1) Rename all your ember-table impot to ember-table-legacy. (for example: `import EmberTable from 'ember-table/components/ember-table'` becomes `import EmberTableLegacy from 'ember-table-legacy/components/ember-table-legacy'`. Remove reference of `ember-table` in `package.json`. +2) Install `ember-table-legacy` using `yarn add ember-table-legacy` or `npm install ember-table-legacy` +3) Run your app to make sure that it works without issue. +4) Install this `ember-table` repo +5) You can start using new version of Ember table from now or replace the old ones. From f1920875f21e8226bc649fc4662f5132c5fd99e5 Mon Sep 17 00:00:00 2001 From: Billy Pham Date: Tue, 5 Dec 2017 09:51:18 -0800 Subject: [PATCH 2/5] Fix grammar mistake + update guide for using custom footer & header components --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56c379589..f4ea8e3de 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ If you want to use default table style, import the `ember-table/default` SASS fi To use footer for your table, pass `footerRows` param to ember table. Each element in `footerRows` represents a row in table footer. The footer row takes `valuePath` field in each column to render data for each footer cell, similar to table body. ### Custom header and custom footer -By default Ember table cell renderes simple text defined inside each `column`. To custom table header or footer, you can pass in `headerComponent` and `footerComponent` fields in each column data. +By default Ember table header renders text defined by `columnName` or `footerValue` inside each `column`. To custom table header or footer, you can pass in `headerComponent` and `footerComponent` fields in each column data. When the `headerComponent`(or `footerComponent`) is defined, the `columnName`(or `footerValue`) field is ignored. #### Usage ``` { From c214c5bccb8d6045dd28b7d2ab1b5a67f12df0ea Mon Sep 17 00:00:00 2001 From: Billy Pham Date: Tue, 5 Dec 2017 09:52:57 -0800 Subject: [PATCH 3/5] Add Ember version support statement --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f4ea8e3de..6d32b94f1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Ember Table An addon to support large data set and a number of features around table. `Ember Table` can -handle over 100,000 rows without and rendering or performance issue. +handle over 100,000 rows without and rendering or performance issue. This version of `Ember Table` supports 1.11 to latest version of Ember. ## Install From c4bd534eba2140f04a9ec06f009e9a2b94493132 Mon Sep 17 00:00:00 2001 From: Billy Pham Date: Tue, 5 Dec 2017 12:06:11 -0800 Subject: [PATCH 4/5] Address comments --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6d32b94f1..3649354ea 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Ember Table An addon to support large data set and a number of features around table. `Ember Table` can -handle over 100,000 rows without and rendering or performance issue. This version of `Ember Table` supports 1.11 to latest version of Ember. +handle over 100,000 rows without and rendering or performance issue. + +This version of `Ember Table` supports Ember 1.11 to latest version of Ember. ## Install @@ -107,7 +109,7 @@ If you want to use default table style, import the `ember-table/default` SASS fi To use footer for your table, pass `footerRows` param to ember table. Each element in `footerRows` represents a row in table footer. The footer row takes `valuePath` field in each column to render data for each footer cell, similar to table body. ### Custom header and custom footer -By default Ember table header renders text defined by `columnName` or `footerValue` inside each `column`. To custom table header or footer, you can pass in `headerComponent` and `footerComponent` fields in each column data. When the `headerComponent`(or `footerComponent`) is defined, the `columnName`(or `footerValue`) field is ignored. +By default Ember table header renders text defined by `columnName` or `footerValue` inside each `column`. To customize table header or footer, you can pass in `headerComponent` and `footerComponent` fields in each column data. When the `headerComponent`(or `footerComponent`) is defined, the `columnName`(or `footerValue`) field is ignored. #### Usage ``` { @@ -118,10 +120,10 @@ By default Ember table header renders text defined by `columnName` or `footerVal } ``` ## Migrating from old Ember table -To support smooth migration from old version of Ember table (support only till ember 1.11), we have move the old source code to separate package [ember-table-legacy](https://github.com/Addepar/ember-table-legacy). It's a separate package from this Ember table package and you can install it using yarn or npm. This allows you to have 2 versions of ember table in your code base and you can start your migrating one table at at time. The recommended migration steps is as follow (if you are using ember 1.11): +To support smooth migration from old version of Ember table (support only till ember 1.11), we have move the old source code to separate package [ember-table-legacy](https://github.com/Addepar/ember-table-legacy). It's a separate package from this Ember table package and you can install it using yarn or npm. This allows you to have 2 versions of ember table in your code base and you can start your migrating one table at at time. The recommended migration steps are as follows (if you are using ember 1.11): -1) Rename all your ember-table impot to ember-table-legacy. (for example: `import EmberTable from 'ember-table/components/ember-table'` becomes `import EmberTableLegacy from 'ember-table-legacy/components/ember-table-legacy'`. Remove reference of `ember-table` in `package.json`. +1) Rename all your ember-table import to ember-table-legacy. (for example: `import EmberTable from 'ember-table/components/ember-table'` becomes `import EmberTableLegacy from 'ember-table-legacy/components/ember-table-legacy'`. Remove reference of `ember-table` in `package.json`. 2) Install `ember-table-legacy` using `yarn add ember-table-legacy` or `npm install ember-table-legacy` 3) Run your app to make sure that it works without issue. -4) Install this `ember-table` repo -5) You can start using new version of Ember table from now or replace the old ones. +4) Reinstall the latest version of this `ember-table` repo. +5) You can start using new version of Ember table from now or replacing the old ones. From 65a2059d7556a59fb81b3278ade9a119634bed08 Mon Sep 17 00:00:00 2001 From: Billy Pham Date: Tue, 5 Dec 2017 14:00:14 -0800 Subject: [PATCH 5/5] Break line for long paragraph --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3649354ea..570b926df 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # Ember Table An addon to support large data set and a number of features around table. `Ember Table` can -handle over 100,000 rows without and rendering or performance issue. - -This version of `Ember Table` supports Ember 1.11 to latest version of Ember. +handle over 100,000 rows without and rendering or performance issue. This version of `Ember Table` +supports Ember 1.11 to latest version of Ember. ## Install @@ -106,10 +105,16 @@ The rendered table is a plain table without any styling. You can define styling If you want to use default table style, import the `ember-table/default` SASS file. ### Optional Footer -To use footer for your table, pass `footerRows` param to ember table. Each element in `footerRows` represents a row in table footer. The footer row takes `valuePath` field in each column to render data for each footer cell, similar to table body. +To use footer for your table, pass `footerRows` param to ember table. Each element in `footerRows` +represents a row in table footer. The footer row takes `valuePath` field in each column to render +data for each footer cell, similar to table body. ### Custom header and custom footer -By default Ember table header renders text defined by `columnName` or `footerValue` inside each `column`. To customize table header or footer, you can pass in `headerComponent` and `footerComponent` fields in each column data. When the `headerComponent`(or `footerComponent`) is defined, the `columnName`(or `footerValue`) field is ignored. +By default Ember table header renders text defined by `columnName` or `footerValue` inside each +`column`. To customize table header or footer, you can pass in `headerComponent` and +`footerComponent` fields in each column data. When the `headerComponent`(or `footerComponent`) is +defined, the `columnName`(or `footerValue`) field is ignored. + #### Usage ``` { @@ -119,10 +124,18 @@ By default Ember table header renders text defined by `columnName` or `footerVal width: 180 } ``` -## Migrating from old Ember table -To support smooth migration from old version of Ember table (support only till ember 1.11), we have move the old source code to separate package [ember-table-legacy](https://github.com/Addepar/ember-table-legacy). It's a separate package from this Ember table package and you can install it using yarn or npm. This allows you to have 2 versions of ember table in your code base and you can start your migrating one table at at time. The recommended migration steps are as follows (if you are using ember 1.11): -1) Rename all your ember-table import to ember-table-legacy. (for example: `import EmberTable from 'ember-table/components/ember-table'` becomes `import EmberTableLegacy from 'ember-table-legacy/components/ember-table-legacy'`. Remove reference of `ember-table` in `package.json`. +## Migrating from old Ember table +To support smooth migration from old version of Ember table (support only till ember 1.11), we have +move the old source code to separate package [ember-table-legacy](https://github.com/Addepar/ember-table-legacy). +It's a separate package from this Ember table package and you can install it using yarn or npm. +This allows you to have 2 versions of ember table in your code base and you can start your migrating +one table at at time. The recommended migration steps are as follows (if you are using ember 1.11): + +1) Rename all your ember-table import to ember-table-legacy. (for example: +`import EmberTable from 'ember-table/components/ember-table'` becomes +`import EmberTableLegacy from 'ember-table-legacy/components/ember-table-legacy'`. Remove reference +of `ember-table` in `package.json`. 2) Install `ember-table-legacy` using `yarn add ember-table-legacy` or `npm install ember-table-legacy` 3) Run your app to make sure that it works without issue. 4) Reinstall the latest version of this `ember-table` repo.