List Tool 2.0

[neSpecc]

We're gonna improve list creation experience:

• Merge List, NestedList, Checklist into a single tool
• Old list tool and checklist will be archived
• NestedList will be renamed to List
• We're gonna update major version

Steps

• Discover code
• Implement the new configurable style — "checkbox"
• Think about data model (it should support nesting and check-states)
• Make nesting optional (by maxLevel config option)
• Improve tabulation UX
• Support Ol list attributes (type, reversed, start)
• Tool icon should respect defaultStyle config option Tools Icon #70

[Sozialarchiv]

I think merging List and NestedList is a very good idea.

I think it's worth considering whether the checklist should also be a part of it.

From a programming point of view, there are certainly synergies. On the other hand, the checklist becomes part of the additional code.

From the user's point of view, they are all lists. But you can also argue that checklists are a different kind of list.

Maybe typescript would be a nice thing for the plugin.

[neSpecc]

But you can also argue that checklists are a different kind of list

@Sozialarchiv could you explain it? Are there any disadvantages from the end user perspective?

[Sozialarchiv]

I assume that there would only be menu entry "List" in the add menu. I asked whether the checklist would then be easily overlooked. But maybe it's just a matter of getting used to it.

From my point of view, it would perhaps be good if you could deactivate the checklist.

[neSpecc]

List tool can export several entries at the toolbox

[Sozialarchiv]

List tool can export several entries at the toolbox

Great. Then I take the argument back. :)

[cmeeren]

We currently have a feature request to support nested lists in our product, so we are considering supporting this nested list block. Is there any timeframe for the merge described in this issue? We need to know if we should wait or not.

Also, what is the thinking behind using "type" : "list" for the nested list block? That value is also used for the normal list, and the schemas are incompatible. This means that type can't be used as a discriminator, which I think is the intention with type in the first place. (Not sure how list/nested list handles this internally, but it can be important for other custom parsers.) This is an issue since we currently have lots of data with the normal list tool. Will this be alleviated with list tool 2.0?

[Sozialarchiv]

I would suggest a step-by-step approach so that the improvements reach users in the foreseeable future:

1. Merging list and nested-list. To do this, we would actually only have to add the compatibility PR into nested-list. Then we could set list to depracted and rename nested-list to list.

2. Fixing important bugs from the issue list and work through the PR list.

3. (optional) Typescript migration.

4. Integration of the Checkbos plugin.

[cmeeren]

I can confirm that of those four points, the first point would unblock us (with the caveat that I haven't looked at the open bug issues).

However, I would like to know more about the point I made regarding the type discriminator and backwards compatibility (i.e., not just for this tool itself, but for all other 3rd party editor.js parsers, which may have trouble with incompatible schema for any given discriminator value).

[Sozialarchiv]

However, I would like to know more about the point I made regarding the type discriminator and backwards compatibility (i.e., not just for this tool itself, but for all other 3rd party editor.js parsers, which may have trouble with incompatible schema for any given discriminator value).

I agree that this is an important point.

I also see the point you have made here: #15 (comment)

My proposal would be to use another type value, such as list2, nested-list, or similar.

However, I am not sure whether a new type name is really necessary.

list and nested-list have been using the same type (list) for a long time. This means that parsers have already had to implement a distinction in the past.

In addition checklist could be integrated relatively easily into the data structure of nested-list, without breaking it. Here an suggestion:

current:

{
    "type" : "list",
    "data" : {
        "style" : "unordered",
        "items" : [
            {
              "content": "Apples",
              "items": [
                {
                  "content": "Red",
                  "items": []
                },
                {
                  "content": "Green",
                  "items": []
                },
              ]
            },
            {
              "content": "Bananas",
              "items": [
                {
                  "content": "Yellow",
                  "items": []
                },
              ]
            },
        ]
    }
}

suggestion

{
    "type" : "list",
    "data" : {
        "items" : [
            {
              "content": "Apples",
              "checked" : true
              "items": [
                {
                  "content": "Red",
                  "checked" : false
                  "items": []
                },
                {
                  "content": "Green",
                 "checked" : true
                  "items": []
                },
              ]
            },
            {
              "content": "Bananas",
              "items": [
                {
                  "checked" : true
                  "content": "Yellow",
                  "items": []
                },
              ]
            },
        ]
    }
}

What is not quite clear to me is how you would make sure that the plugin also reads the existing blocks with type checklist. Would you load the plugin for both the type list and the type checklist? But wouldn't the menu entries then appear twice? Or is there a more user-friendly way?

[neSpecc]

We currently have a feature request to support nested lists in our product, so we are considering supporting this nested list block. Is there any timeframe for the merge described in this issue? We need to know if we should wait or not.

We have already started. As always you can support development on Open Collective, it will increase the development speed.

Also, what is the thinking behind using "type" : "list" for the nested list block? That value is also used for the normal list, and the schemas are incompatible. This means that type can't be used as a discriminator, which I think is the intention with type in the first place. (Not sure how list/nested list handles this internally, but it can be important for other custom parsers.) This is an issue since we currently have lots of data with the normal list tool. Will this be alleviated with list tool 2.0?

Actually, tools do not care about the 'type' fields. What remains is on the user side; you can use any type you want by specifying the corresponding key in the tools parameter of the editor config.

import EditorJS from '@editorjs/editorjs';
import NestedList from '@editorjs/nested-list';

const editor = EditorJS({
  // ...
  tools: {
    ...
    myListToolType: NestedList
  },
});

[Sozialarchiv]

Actually, tools do not care about the 'type' fields. What remains is on the user side; you can use any type you want by specifying the corresponding key in the tools parameter of the editor config.

That is true.

But most plugins give an example with a type name.
https://github.com/editor-js/nested-list/blob/main/README.md?plain=1#L39

This example name is used by the most of parsers. That is imho why the question of @cmeeren is relevant. But imho I think we should give list as type example and provide data compatibly to (unnested) list and checklist.