Add migration guide to README #461
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@Addepar/ice |
pzuraq
reviewed
Dec 5, 2017
README.md
Outdated
| ## 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`. |
README.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
We should add line breaks in paragraphs regularly rather than relying on word wrap
README.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
To custom table header or footer -> to customize the table header or footer
README.md
Outdated
| 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 |
There was a problem hiding this comment.
Probably better to word this like "Reinstall the latest version of the main ember-table package"
README.md
Outdated
| @@ -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): | |||
There was a problem hiding this comment.
"The recommended migration steps is as follow" -> "The recommended migration steps are as follows"
pzuraq
approved these changes
Dec 5, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.