Provide a plugin exposing an API that lets you mark keywords

[Reinmar]

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

🆕 Feature request

📃 Other details that might be useful

I'm thinking about a similar feature to https://markjs.io/. Like:

const markerPlugin = editor.plugins.get( 'Marker' );

const marker = markerPlugin.create( {
    in: editor.model.document.getRoot(),                // Allows limitting it to a given range/container.
    element: { name: 'mark', classes: 'find-result' }   // Defines the element to use in the view
} );

marker.mark( 'Foo' );
marker.mark( /Foo\s+Bar/g );

const results = marker.mark( 'Foo', {
    watch: true
} );

for ( const res of results ) { 
    // res {Range|Marker?}
}

(As you can see I had some problem with naming – that'd have to be rethought.)

Such an API could be used by find/replace feature, keyword tracking, possibly spellchecking (although, it'd have to be optimised for performance and async querying mechanism, so problably not in MVP) etc.

---

If you'd like to see this API introduced, add 👍 to this ticket.

[Reinmar]

Another use case: #1592

[Reinmar]

Another use case: #1430

[scofalik]

I think what we (also?) need is a nice tool that would allow us to get text data of a given element and/or get all occurrences of given text in the given element (deep), together with the position where the occurrence happens (and length if we allow regexps). When reading #1430 I came to a conclusion that we have no easy way to find a text in the editor and you need to glue the element's text, search in it and figure out the offset by yourself.

The above could be the base for what you proposed in the original post. I don't like delivering only your proposal because it is limited to using markers.

[andy-bond]

My organization has a use for this feature. In the process of drafting regulations, there is a list of words that should not be used in the text, except for very rare exceptions. We would love to have the ability to highlight these words so that the person drafting can check whether they could use a different allowed word. I think it would also be nice if we could get a count of the number of occurrences of disallowed words, similar to the Word Count Plugin.

[yankustefan]

Our organisation has also use for this, in the context of corporate language, where certain words or phrases should not be used. We can spot them in our backend, but we would like to highlight them in CKEditor programatically. Since we would like to suggest a list of alternatives, it would tie into the "Find (search) in document" feature #1430. Essentially, our goal is to implement something like Grammarly's synonym widget.

[CKEditorBot]

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

[CKEditorBot]

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

[CKEditorBot]

We've closed your issue due to inactivity over the last year. We understand that the issue may still be relevant. If so, feel free to open a new one (and link this issue to it).