Introduce the "set anchor" feature / Bookmarks

[kleinph]

Is this a bug report or feature request? (choose one)

🆕 Feature request

Create a feature that allows the user to insert an anchor to the document, just like in CKEditor 4.

---

If you'd like to see this feature implemented, add 👍 to this post.

[Mgsy]

Hi, thanks for the report. I've converted your ticket to a feature request.

[meecect]

I've been trying to write a plugin using the downcast converter to automatically add an anchor tags to heading tags.

I can't get it to work...in the interim before this feature request is finished, could someone help with the code requried for this? I have followed the docs and have been able to add classses, set attributes, etc, but wheh I try to insert elements, it doesn't seem to work.

Could you give an example of how one could add the linkHref attribute to the text inside a heading tag in a downcast action?

Or, alternatively, (perhaps better), could one create a blank text element with an href attribute and append (or prepend) it to the heading1 element in a downcast action?

[giovannidias1]

any news for this feature?

[aborkhovych]

+1 to this feature request

[523299338]

+2 to this feature request

[wimleers]

Drupal would also benefit from this feature: https://www.drupal.org/project/ckeditor5/issues/3224256.

[hools18]

+1 to this feature request

[PTWvL]

Google brought me here. +1 for this request

[dpf-dd]

#meetoo <3

[vlyalkobixal]

+1 for this too

[shootlens]

+4 for this feature request

[Barik85]

+1 for this feature request

[cmak9149]

+1

[venmathiraj]

+1

[ferrlen]

Is there any progress being made on this issue? I'd like to use CKEditor 5 in my app, but this is a dealbreaker.

It's not particularly hard to implement this feature. I thought of creating a plugin to add anchors, but this wouldn't make much of a difference because links in CKEditor seem to always open in a new window, which is not the behaviour I want. I just want the user to be able to scroll to the desired point in the text.

Edit: it seems it's actually possible to change the behaviour when clicking links https://ckeditor.com/docs/ckeditor5/latest/features/link.html . But honestly at this point it's easier to simply pick another text editor that already has these features set

[amandine-ls]

+1

[goPOSTALman]

Still waiting on this to be added since 2020... wooo!

[dwandeljanicka]

Hi! We have started working on Anchors, and we would like to know your opinion to choose the most useful solution.

How should the anchor be displayed in the editor? Vote with emoji:

🚀 Inline (as it was in CKEditor 4) 

🎉 Out of the text editing area 

👀 I don't need to see the anchors in the editor; it is enough that I can add links to them

[abigail1309]

🚀

[raq007]

🚀

…

On Wed, 7 Aug 2024 at 10:43 AM, dwandeljanicka ***@***.***> wrote: Hi! We have started working on anchors and we would like to know your opinion to chose the most useful solution. *How should the anchor be displayed in the editor? Vote with emoji:* 🚀 Inline (as it was in CKEditor 4) Zrzut.ekranu.2024-07-22.o.14.20.01.png (view on web) <https://github.com/user-attachments/assets/d4b0a485-aa3e-4005-93d3-1a3ece68c69f> 🎉 Out of the text editing area Zrzut.ekranu.2024-08-7.o.09.19.42.png (view on web) <https://github.com/user-attachments/assets/2f38ee12-747c-4e42-95a8-0a7920d14374> Zrzut.ekranu.2024-08-7.o.09.22.32.png (view on web) <https://github.com/user-attachments/assets/c67852bb-57ed-4160-9ef4-543b6835eda3> 👀 I don't need to see the anchors in the editor; it is enough that I can add links to them — Reply to this email directly, view it on GitHub <#1944 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADAS7VBQNCBOJHGXBH4H7UTZQHF2RAVCNFSM4IKBDMC2U5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TEMRXGI4DGMBRGQ2Q> . You are receiving this because you commented.Message ID: ***@***.***>

[joegl]

🚀

[NIWm]

🚀

[SimonChabrier]

🚀

[SimonChabrier]

When will the feature be available please ?

[Witoso]

We are working on this initiative right now. Most likely it will be done in 3 stages, though released together. I will update this comment with the links to more details as we go.

• Bookmarks: part 1 #17063 
• Bookmarks: part 2 #17180
• Improved linking experience #17230

After the research, we decided that creating reference links will be called Bookmarks to be more content-creator friendly, and aligned with the most popular systems.

[Witoso]

The work on bookmarks progresses quite nicely, and we decided to make a release of it without waiting for linking experience improvements (see scope in the comment) That way, you will be able to use the plugin earlier. TBD still on the exact release date.

But there's a second part that we will be focusing on immediately afterward: linking improvements and linking to bookmarks (#17230). I added a few UI prototypes how improved linking balloon may look like, and which areas will change. Please don't hesitate to leave your comments on the issue 😊

[Witoso]

Hey, we've finished the main work. This is planned for release but for the next iteration. We've just started testing phase for a bug fix release (planned for beginning of November). This is scheduled for the next one (~beginning of December).

Meanwhile, we continue to work on linking improvements and linking to bookmarks (#17230).

[dalin-]

I love getting a native implementation into CKEditor5. I have one suggestion, but I've never posted something in this community, so I have no idea how you do things.

If the new implementation matches what's shown in the screenshots in the OP description, then there's some UX issues that you might consider addressing before this goes out. The main issue is that you've got to know a lot about the underlying mechanics of anchors before you're able to use this thing. Most users on most sites won't know enough to be able to make use of this.

Here's a suggestion for the pop-up window.

Feel free to run with this, turn it into a new issue, or whatever fits best around here.

---

Use an anchor to link to a section within a page (not just the top):

Anchor name
⊏ニニニニニニニニニニ⊐ ✓ ⨯

To link to this anchor from within the current page: Don't use the full URL. Instead use a number sign followed by the name of the anchor.
#[anchor-name] ⎘
From another page: Use the full URL of this page followed by a number sign and the name of the anchor.

---

Ideally [anchor-name] populates automatically as the user types in the text box. The ⎘ icon should act as a button to copy the anchor to the clipboard. But both of these could be moved to follow-up issues if necessary.

[Witoso]

@dalin- thanks for the feedback!

We will release the bookmarks without those, but I will make sure to mention in the docs that it's a feature v1 without all final touches. The final UI is connected with the #17230 where the list of bookmarks to link to will be automatically prefilled. We also will provide integrators to create their lists (bookmarks on other pages, for example).

I believe that informative descriptions should be the last resort for intuitive user interfaces, as they make the visuals bloated and the text has always the possibility of being misinterpreted. We also have tons of different use cases that the editor is used in, and we need to be careful about writing copy that may not be relevant for some of those.