Legacy Knowledge Base
Published Jul. 2, 2025

Use CKEditor plugins button on AlloyEditor

Written By

Georgel Pop

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

Environment

  • DXP 7.0, DXP 7.1, DXP 7.2, DXP 7.3

Resolution

  • The solution is to add on the configuration this extraPlugins needed along with colorbutton:
    "ae_uibridge,ae_richcombobridge,ae_panelmenubuttonbridge,ae_menubridge,ae_menubuttonbridge,ae_buttonbridge,colorbutton";
  • In the case of colorbutton plugin, we have two buttons we can call and use: "TextColor", "BGColor"
  • Take this sample code as a reference, changing AlloyEditorConfigContributor.java
    @Override
    public void populateConfigJSONObject(
    JSONObject jsonObject, Map<String, Object> inputEditorTaglibAttributes,
    ThemeDisplay themeDisplay,
    RequestBackedPortletURLFactory requestBackedPortletURLFactory) {
    super.populateConfigJSONObject(
    jsonObject, inputEditorTaglibAttributes, themeDisplay,
    requestBackedPortletURLFactory);
    jsonObject.put("entities", Boolean.FALSE);
    String extraPlugins = jsonObject.getString("extraPlugins");
    String extraPluginsNeeded = "ae_uibridge,ae_richcombobridge,ae_panelmenubuttonbridge,ae_menubridge,ae_menubuttonbridge,ae_buttonbridge,colorbutton";
    if (Validator.isNotNull(extraPlugins)) {
    extraPlugins += ",itemselector,media,embedurl," + extraPluginsNeeded;
    }
    else {
    extraPlugins = "itemselector,media,embedurl," + extraPluginsNeeded;
    }
    jsonObject.put(
    "extraPlugins", extraPlugins
    ).put(
    "toolbars", getToolbarsJSONObject(themeDisplay.getLocale())
    );
    }
    ...
    protected JSONObject getToolbarsStylesSelectionsTextJSONObject(
    Locale locale) {
    return JSONUtil.put(
    "buttons",
    JSONUtil.putAll(
    getStyleFormatsJSONObject(locale), "bold", "italic",
    "underline", "ol", "ul", "linkBrowse", "TextColor", "BGColor")
    ).put(
    "name", "text"
    ).put(
    "test", "AlloyEditor.SelectionTest.text"
    );
    }

Additional Information

Did this article resolve your issue ?

Legacy Knowledge Base