Consider deprecating in favor of the CKEditor Plugin Pack module

Created on 6 June 2025, 28 days ago

Problem/Motivation

The CKEditor Plugin Pack module has a new Bookmark sub-module that's used for inserting anchor links (bookmarks). It does the same thing as this module, but I think the UX is a bit nicer.

I think we should consider deprecating this module in favor of that one.

Steps to reproduce

Proposed resolution

Remaining tasks

  • ✅ File an issue
  • ➖ Addition/Change/Update/Fix
  • ➖ Testing to ensure no regression
  • ➖ Automated unit testing coverage
  • ➖ Automated functional testing coverage
  • ➖ UX/UI designer responsibilities
  • ➖ Readability
  • ➖ Accessibility
  • ➖ Performance
  • ➖ Security
  • ➖ Documentation
  • ➖ Code review by maintainers
  • ➖ Full testing and approval
  • ➖ Credit contributors
  • ➖ Review with the product owner
  • ➖ Release notes snippet
  • ❌ Release

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • N/A
🌱 Plan
Status

Active

Version

3.0

Component

Miscellaneous

Created by

🇺🇸United States bkosborne New Jersey, USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @bkosborne
  • 🇯🇴Jordan Rajab Natshah Jordan

    Thanks, Brian, for suggesting.

    Bookmark are not Anchors for sure.
    We could have both.

  • 🇺🇸United States bkosborne New Jersey, USA

    Hi Rajab,

    I'm still a bit confused about the distinction.

    What makes you say that Bookmarks are visually marked anchors on the final front end? The documentation for the CKEditor plugin doesn't mention that.

    The plugin implements the bookmarks in the same way that Anchor Link does. It creates a <a id="name"></a> element. That wouldn't be rendered on the front-end in either plugin unless you added specific styling for it.

  • 🇯🇴Jordan Rajab Natshah Jordan

    Brian, let us agree to disagree.
    Do what you like in your projects/products.

    Not considering or moving forward with your suggestion.
    Thank you, by the way.
    Closing this issue, moving the conversation to the CKEditor 5 Plugin Pack module.

  • 🇺🇸United States justcaldwell Austin, Texas

    Regarding #3: out of the box, Bookmarks definitely do not result in a visual front-end indicator. As @bkosborne says, you would have to add some styling to accomplish that.

    Per the introductory github issue, Bookmark is a CKEditor core plugin to support html anchors and provide a UI to create/edit them. They chose the name Bookmark as "... it’s a much more recognizable name for content creators. Its name and iconography are used in current popular content creation systems (Word, Google Docs)."

    Hoping that Drupal CMS and Drupal Core add the default Anchor button to CKEditor 5

    If that happens, I think that would be the Bookmark button, as Bookmarks are CKEditor's implementation of anchors.

    As someone who has invested some time into the anchor_link issue queue, I think there are some issues with the underlying js plugin, and most projects would be best-served using Bookmark — certainly any new projects. So, respectfully, I think deprecation is worth contemplating.

    At a minimum, you might consider mentioning and linking to the Plugin Pack as an alternative. There's also CKEditor5 Bookmark , which I created before Plugin Pack added the feature. (I maintain it now just for folks who don't need any other features from the Plugin Pack.)

  • 🇯🇴Jordan Rajab Natshah Jordan

    Thanks, Michael, for following up.
    I like the CKEditor 5 Bookmark .. As a small and light plugin
    It would be better than the big CKEditor 5 Plugin Pack

    Happy with the Bookmark ( as in page Anchor linking ) in Drupal CMS or Drupal Core.
    Open the best command name when editing. I like the Bookmark name too.
    Bookmarks could be confused with Bookmarked pages for users. a bit like LinkIt

    Maybe it could be re-named to in-page/same-page bookmark or page location/position mark
    Or Pagemark
    Bookmark is the easiest to use as a Caption name.

    The idea of using the big CKEditor 5 Plugin Pack is what I do not like.
    It has not been added to Drupal Core or Drupal CMS yet.

    CKEditor 5 Plugin Pack has commercial Premium Features, free and paid services (sometimes they are mixed)
    You will for sure face issues like
    🐛 WProofreader Plugin Issue Active

  • 🇯🇴Jordan Rajab Natshah Jordan

    Having CKEditor 5 Bookmark on the table for experimentation. (Discussion is open internally about it )

    As it is using the Drupal Core CKEditor asset code directly.

    Maybe it could be a good one.
    Please propose a Drupal Core issue to add CKEditor 5 Bookmark to Drupal Core or Drupal CMS.

  • 🇯🇴Jordan Rajab Natshah Jordan

    Re-opened the issue to continue the discussion.

    I have a questions:

    Why the Drupal Core team did not add an implementation for Bookmarks yet?
    Even tho that the bookmark plugin provided in the core CKEditor assets.
    what do you think about this? had they disliked the name or the method? or no bandwidth time for that only?

    I think LinkIt or the work on having LinkIt alike in Drupal core could be the winner option. What do you think?

Production build 0.71.5 2024