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

Removing highlight from element should only require highlight id #4197

Closed
szymonkups opened this issue Oct 11, 2017 · 1 comment · Fixed by ckeditor/ckeditor5-engine#1165
Closed

Removing highlight from element should only require highlight id #4197

szymonkups opened this issue Oct 11, 2017 · 1 comment · Fixed by ckeditor/ckeditor5-engine#1165
Assignees
@szymonkups
Labels
package:engine status:discussion type:improvement This issue reports a possible enhancement of an existing feature.
Milestone
iteration 13

Comments

@szymonkups
Copy link
Contributor

Elements can provide custom properties setHighlight and removeHighlight to handle highlighting by themselves. Currently, converters pass HighlightDescriptor object to both functions. This works well when converters are adding and removing highlights. When there is a separate logic to remove the highlight it must provide whole descriptor to removeHighlight method which is not so convenient. Maybe it would be better if:

  • setHighlight will accept full descriptor to set the highlight (as it is now),
  • removeHighlight accepts only the descriptor id to be removed.
@szymonkups szymonkups self-assigned this Oct 11, 2017
@scofalik
Copy link
Contributor

I am fine with removeHighlight receives only an id.

scofalik referenced this issue in ckeditor/ckeditor5-engine Oct 16, 2017
@scofalik
Merge pull request #1165 from ckeditor/t/1164
7bde6f7 
Other: The `removeHighlight()` function now accepts descriptor id instead of a `HighlightDescriptor` object. Closes #1164.
@mlewand mlewand transferred this issue from ckeditor/ckeditor5-engine Oct 9, 2019
@mlewand mlewand added this to the iteration 13 milestone Oct 9, 2019
@mlewand mlewand added status:confirmed status:discussion type:improvement This issue reports a possible enhancement of an existing feature. package:engine labels Oct 9, 2019
@szymonkups szymonkups mentioned this issue Oct 11, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@szymonkups szymonkups

Labels
package:engine status:discussion type:improvement This issue reports a possible enhancement of an existing feature.
Projects
None yet
Milestone
iteration 13
Development

Successfully merging a pull request may close this issue.

removeHighlight method now accepts highlight id ckeditor/ckeditor5-engine
3 participants
@scofalik @szymonkups @mlewand