Can I add custom controls into Confluence Addon PropertyPanel? Edited

Hi! I found the info about how to customize PropertyPanel with user buttons.

Unfortunatelly, the example shows only the basic staff - how to add a simple button and how to add event listener to it.

But I saw some pictures, where developers add buttons with images, and even another controls, such as checkboxes, text inputs and delimiters.

Does onpremise Confluence support this functionality?

1 answer

1 accepted

Solve it.

The correct answer is:

  1. Register panel initialization through
    AJS.Confluence.PropertyPanel.Macro.registerInitHandler
  2.  Inside handler the first patameter would be macro placeholder, and teh second is buttons array. If you want to modify the existing button with custom HTML, you could just add 'html' property to one of the object, like this 
    buttons[1].html = '<input type="text" />';
    Or, you can even insert new buttons structure into array.
  3. If you want to bind event handlers to your custom controls, register window event handler to listen for created panel event.
    $(window).on('created.property-panel', function () {
    //work with DOM controls here
    });

Summary function code could look like this:

AJS.Confluence.PropertyPanel.Macro.registerInitHandler(function(macroPlaceholder, buttons) {
 //Make what you want with the buttons array. Add or set 'html' property to any custom html you want.
 buttons[1].html = '<input id="PropertyPanelCustomInput" type="text" />';
 $(window).once('created.property-panel', function () {
//Add any event handlers to you custom controls here
$('PropertyPanelCustomInput').on('change', function() {
//Yeah, great. Now I know how to do that!
});
});
}, 'myplugin');

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Posted Jul 10, 2018 in Confluence

We want to see the templates you've created in Confluence!

Hi Community, Jessica here from the Confluence Product Marketing team!  July’s community challenge is all about sharing pictures  — and as an extension of our first post on what ...

781 views 23 12
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you