Legacy Knowledge Base
Published Jul. 2, 2025

How to customize the AlloyEditor hyperlink dropdown list?

Written By

Alfonso Crisci

How To articles are not official guidelines or officially supported documentation. They are community-contributed content and may not always reflect the latest updates to Liferay DXP. We welcome your feedback to improve How To articles!

While we make every effort to ensure this Knowledge Base is accurate, it may not always reflect the most recent updates or official guidelines.We appreciate your understanding and encourage you to reach out with any feedback or concerns.

Legacy Article

You are viewing an article from our legacy "FastTrack" publication program, made available for informational purposes. Articles in this program were published without a requirement for independent editing or verification and are provided"as is" without guarantee.

Before using any information from this article, independently verify its suitability for your situation and project.

Issue

  • Business needs may sometimes require to customize the AlloyEditor hyperlink dropdown list in the AlloyEditor toolbar:

    _blank.png

Environment

  • Liferay DXP 7.2

Resolution

You can provide additional configuration to the link dropdown list. The best approach to do it is creating an EditorConfigContributor passing the buttonCfg:

  buttonCfg: {
'linkEdit': {
allowedTargets: [
{
label: AlloyEditor.Strings.linkTargetDefault,
value: ''
}, {
label: AlloyEditor.Strings.linkTargetBlank,
value: '_blank'
}
]
}

This is somehow similar to what we are already doing in AlloyEditorCreoleEditorConfigContributor.java. So in the end, the cleanest solution is just adding below code into populateConfigJSONObject method:

JSONArray allowedTargetsJSONObject = JSONUtil.putAll(
JSONUtil.put("label","_self (same tab)").put("value","_self"),
JSONUtil.put("label","_blank (new tab)").put("value","_blank")
);

JSONObject linkEditJSONObject = JSONUtil.put(
"allowedTargets", allowedTargetsJSONObject
);

JSONObject buttonCfgJSONObject = JSONUtil.put(
"linkEdit", linkEditJSONObject);
jsonObject.put(
"buttonCfg", buttonCfgJSONObject
);

Attached, a small plugin demonstrating the new behavior.

Did this article resolve your issue ?

Legacy Knowledge Base