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.

Sign up for GitHub

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

Jump to bottom

Depreciate Old List Plugins in Favor of DocumentList Equivalents #14942

Closed
Tracked by #15037
arkflpc opened this issue Sep 6, 2023 · 2 comments · Fixed by #15572
Closed
Tracked by #15037

Depreciate Old List Plugins in Favor of DocumentList Equivalents #14942

arkflpc opened this issue Sep 6, 2023 · 2 comments · Fixed by #15572
Assignees
@niegowski @arkflpc
Labels
squad:core Issue to be handled by the Core team. type:task This issue reports a chore (non-production change) and other types of "todos".
Milestone
iteration 70 (v41...

Comments

@arkflpc
Copy link
Contributor

arkflpc commented Sep 6, 2023 •
edited by Witoso
Loading

Provide a description of the task

Part of #14632.

Scope

  1. Rename existing List* plugins to LegacyList* plugins.
    This change will allow integrators to fall back to the old solution if they encounter any issues after an update.
  2. Promote DocumentList* Plugins (by renaming them to List*)
    This should enable document lists for all integrations. Assuming we achieved feature parity, users should not miss any feature.
  3. Support current configurations:
    • Introduce DocumentList* plugins that pull the new List* plugins as a requirement.
    • If an integration currently uses the DocumentList, it should continue to work without necessitating any configuration changes.
    • console.warning should suggest updating configurations.
  4. Completely remove the ListStyle plugin. It has been deprecated for some time now.
  5. Write migration guide.
    • Mention the possibility of using LegacyList in case of issues.
    • Mention the multiBlock config.

📃 Other details

  • Browser: …
  • OS: …
  • CKEditor version: …
  • Installed CKEditor plugins: …
@arkflpc arkflpc added type:task This issue reports a chore (non-production change) and other types of "todos". squad:core Issue to be handled by the Core team. labels Sep 6, 2023
@arkflpc arkflpc mentioned this issue Aug 16, 2023
Closed
4 tasks
@Witoso Witoso mentioned this issue Sep 21, 2023
Closed
3 tasks
@Witoso Witoso added Epic and removed Epic labels Nov 30, 2023
@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 Dec 6, 2023
@arkflpc
Copy link
Contributor Author

arkflpc commented Dec 6, 2023

Migration guide can be developed in parallel with the list renaming.

@niegowski niegowski self-assigned this Dec 19, 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 Dec 19, 2023
@niegowski niegowski mentioned this issue Dec 20, 2023
Merged
@arkflpc arkflpc self-assigned this Dec 27, 2023
@godai78
Copy link
Contributor

godai78 commented Jan 2, 2024

Can you have a look at changes in the docs, too, after this is done? Probably needs some tinkering in the Common API sections: #14960

@Witoso Witoso mentioned this issue Jan 2, 2024
Merged
niegowski added a commit that referenced this issue Jan 4, 2024
@niegowski
Merge pull request #15572 from ckeditor/ck/14942
b9fb73a 
Other (list): The Document List feature was promoted to the main list feature implementation. The "Document" prefix was removed while the old list implementation was prefixed with the "Legacy" keyword. A compatibility alias plugins were introduced (`DocumentList`, `DocumentListProperties`, `TodoDocumentList`) for backward compatibility but those are marked as deprecated and log a warning in the browser console. Closes #14942.

MINOR BREAKING CHANGE (list): All old list plugins are now prefixed with `legacy` (including directory names):  `List` -> `LegacyList`, `ListProperties` -> `LegacyListProperties`, `TodoList` -> `LegacyTodoList`, `ListEditing` -> `LegacyListEditing`, `ListUtils` -> `LegacyListUtils`, `ListPropertiesEditing` -> `LegacyListPropertiesEditing`, `TodoListEditing` -> `LegacyTodoListEditing`. See #14942.

MINOR BREAKING CHANGE (list): The Document List plugins are now not prefixed with `document` (including directory names): `DocumentList` -> `List`, `DocumentListProperties` -> `ListProperties`, `TodoDocumentList` -> `TodoList`, `DocumentListEditing` -> `ListEditing`, `DocumentListUtils` -> `ListUtils`, `DocumentListPropertiesEditing` -> `ListPropertiesEditing`, `DocumentListPropertiesUtils` -> `ListPropertiesUtils`, `TodoDocumentListEditing` -> `TodoListEditing`. See #14942.

MAJOR BREAKING CHANGE (list): The `AdjacentListsSupport` plugin is moved from the `documentlist` directory to the `list` directory. See #14942.

MINOR BREAKING CHANGE (list): The `ListStyle` plugin was removed since it was deprecated for a while. Use the `ListProperties` plugin instead. See #14942.
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Jan 4, 2024
@CKEditorBot CKEditorBot added this to the iteration 70 milestone Jan 4, 2024
@CKEditorBot CKEditorBot mentioned this issue Jan 5, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@niegowski niegowski

@arkflpc arkflpc

Labels
squad:core Issue to be handled by the Core team. type:task This issue reports a chore (non-production change) and other types of "todos".
Projects
None yet
Milestone
iteration 70 (v41.0.0)
Development

Successfully merging a pull request may close this issue.

Deprecate old list plugins ckeditor/ckeditor5
5 participants
@niegowski @arkflpc @Witoso @CKEditorBot @godai78