Todo Plugin

[zbeyens]

We have the TodoListPlugin where each todo list item is a block, following the same logic than ListPlugin.

TodoPlugin will enable support for inline todos (checkbox) when entering []

[pubuzhixing8]

Is this a general feature or does other editors do this?

[zbeyens]

Most editors don't have this, I just saw it in Roam

[whoisandy]

We have the TodoListPlugin where each todo list item is a block, following the same logic than ListPlugin.

TodoPlugin will enable support for inline todos (checkbox) when entering []

@zbeyens Shouldn't the todo list plugin be conforming to the (GFM or Extended spec) for common mark where the todo list is similar to a unordered list except the list item child has a checked attribute? With the current todo list plugin implementation, each todo list is a block element at the top level of the state. As per the spec it should be a child of an unordered list -> list item -> list item child. The difference between both the implementations with respect to the editor state can be seen below. Just a thought though.

Current & Desired Implementation Comparison

State in current plugin implementation

[
  {
    "type": "action_item",
    "children": [
      {
        "text": "one"
      }
    ]
  },
  {
    "type": "action_item",
    "children": [
      {
        "text": "two"
      }
    ]
  },
  {
    "type": "action_item",
    "children": [
      {
        "text": "three"
      }
    ]
  }
]

Desired State object with respect to the spec.

{
  "type": "ul",
  "children": [
    {
      "type": "li",
      "children": [
        {
          "type": "lic",
          "children": [
            {
              "type": "action_item",
              "children": [
                {
                  "text": "one"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "type": "li",
      "children": [
        {
          "type": "lic",
          "children": [
            {
              "type": "action_item",
              "children": [
                {
                  "text": "two"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "type": "li",
      "children": [
        {
          "type": "lic",
          "children": [
            {
              "type": "action_item",
              "children": [
                {
                  "text": "three"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

[zbeyens]

I agree it should be pluggable to the list plugin, and even the "indent list" one. Then we could write withTodoList to control what happens on insert break, etc.