Skip to content

DOC-1723 - Update link_quicklink option and mceLink command documentation #4002

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

Open
kemister85 wants to merge 2 commits into
base: tinymce/8
Choose a base branch
from
+16 −3
Open

DOC-1723 - Update link_quicklink option and mceLink command documentation #4002

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3a9c54
Docs: DOC-1723 - Update link_quicklink option and mceLink command doc…
kemister85 Mar 4, 2026
3a75808
Update modules/ROOT/partials/configuration/link_quicklink.adoc
kemister85 Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions modules/ROOT/partials/commands/link-cmds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
[[mceLink]]
[cols="1,3",options="header"]
|===
|Command |Description
|mceLink |Opens the Link or Quicklink Dialog at the current cursor position or for the current selection.
|mceLink |Opens the Link dialog or the link context toolbar at the current cursor position or for the current selection. The behaviour depends on the xref:link.adoc#link_quicklink[`+link_quicklink+`] option. Pass `+{ dialog: true }+` as the third argument to always open the full Link dialog, even when `+link_quicklink+` is enabled.
|===

.Example
.Example: open link dialog or context toolbar (default behaviour)
[source,js]
----
tinymce.activeEditor.execCommand('mceLink');
----

.Example: always open the full Link dialog
[source,js]
----
tinymce.activeEditor.execCommand('mceLink', false, { dialog: true });
----
6 changes: 5 additions & 1 deletion modules/ROOT/partials/configuration/link_quicklink.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[[link_quicklink]]
== `+link_quicklink+`

This option changes the behaviour of the `+CTRL + K+` shortcut. By default, pressing `+CTRL + K+` will open the link dialog. If `+link_quicklink+` is set to `+true+`, pressing `+CTRL + K+` will instead open the link context toolbar. If the cursor is within an existing link, this context toolbar will contain fields for modifying, removing and opening the selected link. If not, the context toolbar allows for the quick insertion of a link.
This option changes the behaviour of the `+CTRL + K+` shortcut and the xref:link.adoc#mceLink[`+mceLink+`] command. By default, pressing `+CTRL + K+` or executing the `+mceLink+` command opens the Link dialog. If `+link_quicklink+` is set to `+true+`, pressing `+CTRL + K+` will, by default, open the link context toolbar instead.

Even when `+link_quicklink+` is set to `+true+`, the full Link dialog can still be invoked by running `+tinymce.activeEditor.execCommand('mceLink', false, { dialog: true });+`.

If the cursor is within an existing link, the context toolbar contains fields for modifying, removing and opening the selected link. If not, the context toolbar allows for the quick insertion of a link.

NOTE: This context toolbar is the same as the context toolbar mentioned in the xref:link.adoc#link_context_toolbar[`+link_context_toolbar+`] documentation above.

Expand Down
Loading