Enabling highlithg in 2SCM should be available as plugin method

[jodator]

📝 Provide a description of the improvement

This is how two-step caret movement is initialised for the link:

ckeditor5/packages/ckeditor5-link/src/linkediting.js

Lines 104 to 109 in 2d24eac

	// Enable two-step caret movement for `linkHref` attribute.
	const twoStepCaretMovementPlugin = editor.plugins.get( TwoStepCaretMovement );
	twoStepCaretMovementPlugin.registerAttribute( 'linkHref' );
	// Setup highlight over selected link.
	inlineHighlight( editor, 'linkHref', 'a', HIGHLIGHT_CLASS );

The problem with that it uses two different means to enable a fully-functional feature.

Options

Option 1: Make inline highlight an option for: registerAttribute() 

twoStepCaretMovementPlugin.registerAttribute( 'linkHref', {
	highlight: {
		tagName: 'a',
		classes: {
			HIGHTLIGHT_CLASS
		}
	}
} );

Option 2: Expose inlineHighlight as plugin method

twoStepCaretMovementPlugin.inlineHighlight( 'linkHref', 'a', HIGHLIGHT_CLASS );

Option 3: Leave as-is

Pros & cons

Option 1:

• pros:
  •  addition to exiting API
• cons:
  •  optional breaking change if inlineHighlight will not be exposed.

Option 2:

• cons:
  • new method, slightly worse API than option 1
  • optional breaking change if inlineHighlight will not be exposed.

Option 3:

• pros:
  • no work 😄
• cons:
  • it's ugly API

My personal favourite: 1.

---

If you'd like to see this improvement implemented, add a 👍 reaction to this post.

[tomalec]

(By my 👍 I mean Option 1 | Option 2 :) )

[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).