Allow Issue Content module to show/hide iFrame based on entity properties.


Product Update - April 14th, 2019

Product Update

Hi everyone, I wanted to leave a quick update on this issue. We have recently shipped to production the ability to show/hide the 'jiraIssueContents' module using conditions with Connect.

This allows you to use all the available conditions within Connect to decide whether to show or hide the iFrame associated with your module. We highly encourage you to refrain from showing empty iframes when there is no content. You should be controlling the lifecycle of this so that if a user removes all content, you would update the issue_entity_property or other way you are using conditions to not show the iFrame.

We also made one last additional improvement on this. If you do evaluate to true using a condition, the iFrame cannot be hidden by the user via the ... in the top right of the iFrame. Instead, if you are evaluating the condition to true, we show the iFrame to all users that view that issue and then each individual user can collapse or extend the iFrame. This will be a per-user setting across all issues.

I realize this may be confusing just reading it via text, but please play around with the new jiraIssueContents module and conditions to see the new behaviour. We will be updating the docs at some point, with a short video clip to make sure this explanation is easy and clear.

Lastly: The additional event behaviour (i.e. dynamically closing the iFrame, or listening to specific types of events to do custom logic) will be added in a seperate ACJIRA issue to track there. I am marking this as completed, since it's intent and focus was to allow Vendors control on whether to show the content iframe or not.


In the new issue view, we created the Issue Content module to take advantage of the new design patterns providing a better user experience that marketplace apps could take advantage of. Initially, we only allowed the iFrame to be displayed if any user clicked on the related quick add icon to display it below. This would then be set on that issue, so that any user coming back to the issue would see the iFrame below moving forward.

However, we quickly learned that there are numerous scenarios where limiting the control to just users clicking on the quick-add icon makes a very poor experience.

Our primary concern, and what our customers have told us & part of the new re-design, is to remove the clutter from all of the empty iFrames everywhere. So ideally, the iFrame is only ever displayed if there is content in there, and users can add the quick-add icon to add content, which would then show up below. This becomes a more seamless experience and feels more native to Jira, like adding attachments, subtasks, linked issues, or confluence pages.

Future state
We are proposing: In the issue content module, you will be able to specify an issue entity property that will determine whether or not to show the iFrame. IF that entity property exists, we show the iFrame, if not, we hide it until content is added or the user clicks to display it below.

This should give back control to the marketplace apps to decide when/how to show their iFrame, given that in some scenarios data is added outside of Jira and should be reflected appropriately when any user goes into view that issue detail. Apps will be able to manage this using entity props on the issue.





Taylor Pechacek


Taylor Pechacek