Add compatability with @editorjs/list data format #39
Conversation
README.md
Outdated
| | Field | Type | Description | | ||
| | ----- | ----------------- | ---------------------------------------- | | ||
| | style | `string` | type of a list: `ordered` or `unordered` | | ||
| | items | `(Item \| string)[]` | the array of list's items | |
There was a problem hiding this comment.
Let me know whether I should keep this README or if there is another way you prefer to document it.
The current README change feels incorrect because this is under the "Output data" header but the data is never saved with items: string[].
There was a problem hiding this comment.
I think, we can remove it at all, because it's just a legacy format support, it shouldn't be mentioned in main Readme
There was a problem hiding this comment.
Also, please increment a patch version
README.md
Outdated
| | Field | Type | Description | | ||
| | ----- | ----------------- | ---------------------------------------- | | ||
| | style | `string` | type of a list: `ordered` or `unordered` | | ||
| | items | `(Item \| string)[]` | the array of list's items | |
There was a problem hiding this comment.
I think, we can remove it at all, because it's just a legacy format support, it shouldn't be mentioned in main Readme
src/index.js
Outdated
| this.data.items = this.data.items.map((item) => { | ||
| if (typeof item === "string") { | ||
| return { content: item, items: [] }; | ||
| } | ||
| return item; | ||
| }); |
There was a problem hiding this comment.
Please, move this code to a separate method
README.md
Outdated
| | Field | Type | Description | | ||
| | ----- | ----------------- | ---------------------------------------- | | ||
| | style | `string` | type of a list: `ordered` or `unordered` | | ||
| | items | `(Item \| string)[]` | the array of list's items | |
There was a problem hiding this comment.
Also, please increment a patch version
- For projects that already used `@editorjs/list`, upgrading to `@editorjs/nested-list` is a pain because the data format is not compatible. - This change detects the `items: string[]` format from `@editorjs/list` and converts to the `items: Item[]` format used here.
| @@ -102,6 +102,7 @@ export default class NestedList { | |||
| }; | |||
|
|
|||
| this.data = data && Object.keys(data).length ? data : initialData; | |||
| this.convertStringDataToListItems() | |||
There was a problem hiding this comment.
lets do that with data before assigning to this.data
| */ | ||
| convertStringDataToListItems() { | ||
| if (this.data.items && this.data.items.length > 0) { | ||
| this.data.items = this.data.items.map((item) => { |
There was a problem hiding this comment.
I'd suggest to skip redundant processing of data in correct format:
if (typeof data.items[1] !== 'string') {
return;
}
|
@cam-perry, Thanks for PR. Please update your PR or give us access to your fork so we can complete this PR. |
@editorjs/listto@editorjs/nested-listis a pain because the data format is not compatible.items: string[]format from@editorjs/listand converts to theitems: Item[]format used here.