Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document lists should have a “simple list” config option #14634

Closed
Witoso opened this issue Jul 21, 2023 · 3 comments · Fixed by #14781
Closed

Document lists should have a “simple list” config option #14634

Witoso opened this issue Jul 21, 2023 · 3 comments · Fixed by #14781
Assignees
Labels
package:list squad:core Issue to be handled by the Core team. type:improvement This issue reports a possible enhancement of an existing feature.

Comments

@Witoso
Copy link
Member

Witoso commented Jul 21, 2023

As we decided to make the Document list the only plugin that introduces the lists, we need to add a config option that still allows creating simple lists.

Why?

Integrators may want to allow simpler content editing, and block creation of blocks in the lists. We have a similar use case in our comments' system. You rarely may want to have a complex markup in small editors. etc.

Scope

  • This option should be opt-in. By default, lists will allow blocks.
  • After setting this option
    • I can only insert list items. Simplified data output <ul><li>a</li><li>b</li></ul> (for ol as well).
    • Typing actions that we have in the document lists (e.g., enter+backspace creates a block) should work differently (as current lists).
  • Documentation.
    • Simple list config in the feature.
    • Release and update guide information.
@Witoso Witoso added type:improvement This issue reports a possible enhancement of an existing feature. package:list squad:core Issue to be handled by the Core team. labels Jul 21, 2023
@Witoso
Copy link
Member Author

Witoso commented Jul 26, 2023

Refinement notes:

  • When there's an option in the config, don't register the command that merges blocks, etc.
  • Schema needs to change (e.g., no heading in the list item).
  • Postfixers: all id's in list items need to be unique.

@CKEditorBot CKEditorBot added the status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. label Jul 26, 2023
@arkflpc arkflpc self-assigned this Aug 3, 2023
@CKEditorBot CKEditorBot added status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. and removed status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Aug 3, 2023
@CKEditorBot CKEditorBot added status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. and removed status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Aug 10, 2023
@CKEditorBot CKEditorBot added status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. and removed status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. labels Aug 24, 2023
@niegowski
Copy link
Contributor

Should we deny multiple types of nested lists in a single list item? Shall simple list allow such structure or should it not (in legacy lists it was not possible):

<ul>
    <li>
        a
        <ol>
            <li>
                b
            </li>
        </ol>
        <ul>
            <li>
                c
            </li>
        </ul>
    </li>
</ul>

@Witoso
Copy link
Member Author

Witoso commented Sep 21, 2023

I don't see a reason why not. I see it as a good enhancement for the user that they can have a bulleted list and inside it have a numbered one. It still matches my definition of simple.

@Reinmar do you remember why Lists v1 didn't have it? Or was it only scope cutting?

@CKEditorBot CKEditorBot added status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. and removed status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Sep 21, 2023
arkflpc added a commit that referenced this issue Sep 25, 2023
Feature (list): Allow restricting list item content to single text block by `list.multiBlock` config option. Closes #14634.
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Sep 25, 2023
@CKEditorBot CKEditorBot added this to the iteration 67 milestone Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:list squad:core Issue to be handled by the Core team. type:improvement This issue reports a possible enhancement of an existing feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants