Just a heads up: On March 24, 2025, starting at 4:30pm CDT / 19:30 UTC, the site will be undergoing scheduled maintenance for a few hours. During this time, the site might be unavailable for a short while. Thanks for your patience.

×
Create
cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
Product Q&A
See all
Community resources
Top groups
Explore all groups
Community resources
Learn
Community resources
Events
Community resources

"show.dialog" Dialog event is not fired

CelesteCS
CelesteCS
Contributor
November 14, 2016

Hello,

I'm writing a simple Confluence Cloud plugin, which has a web-item and a dialog. When Web item is pressed, a dialog is shown. When it is shown. some JS code should be evaluated. I'm trying to subscribe to "show.dialog" event, but my event handler is never run. What is wrong?

I'm sure I'm not the only one who has similar question. So I paste the code here to have a complete sample (when my question is answered) of how it should be done correctly.

Thanks!

 

atlassian-connect.json

{
	"key": "zzz-key",
	"name": "zzz plugin",
	"description": "Zzz",
	"baseUrl": "http://localhost:8889",
	"vendor": 
	{
		"name": "Zzz Labs",
		"url": "http://www.zzz.com"
	},
	"authentication": 
	{
		"type": "none"
	},
	"version": "0.1",
	"modules": 
	{
		"webItems": 
		[
			{
				"location": "system.attachment",
				"weight": 20,
				"styleClasses": 
				[
					"webitem",
					"system-present-webitem"
				],
				"context": "addon",
				"target": 
				{
					"type": "dialogmodule",
					"options": 
					{
						"key": "zzz-dialog"
					}
				},
				"tooltip": 
				{
					"value": "Zzz this file"
				},
				"icon": 
				{
					"width": 16,
					"height": 16,
					"url": "/images/IconZzz.png"
				},
        		"name": 
        		{
					"value": "Zzz this file"
				},
				"key": "zzz-link"
			}
		],
		"dialogs": 
		[
			{
				"key": "zzz-dialog",
				"url": "/zzz-dialog.html?content_id={content.id}&content_version={content.version}&content_type={content.type}&content_plugin={content.plugin}&page_id={page.id}&page_version={page.version}&space_id={space.id}&space_key={space.key}&page_id={page.id}",
				"options": 
				{
					"size": "small",
					"header": 
					{
						"value": "Zzz plugin"
					}
				}
			}
		]
	},
	"scopes":
	[
		"read",
		"write"
	]
}

 

zzz-dialog.html

<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
	<head>
		<meta charset="utf-8">
		<meta http-equiv="X-UA-Compatible" content="IE=EDGE">
		<script id="connect-loader" data-options="sizeToParent:true;">
			(function() {
			  var getUrlParam = function (param) {
			    var codedParam = (new RegExp(param + '=([^&]*)')).exec(window.location.search)[1];
			    return decodeURIComponent(codedParam);
			  };
			
			  var baseUrl = getUrlParam('xdm_e') + getUrlParam('cp');
			  var options = document.getElementById('connect-loader').getAttribute('data-options');
			
			  var script = document.createElement("script");
			  script.src = baseUrl + '/atlassian-connect/all.js';
			
			  if(options) {
			    script.setAttribute('data-options', options);
			  }
			  document.getElementsByTagName("head")[0].appendChild(script);
			})();
		</script>
		<script src="/js/zzz-dialog.js"></script>
	</head>
	<body style="background-color: #FFF">
		<p>Zzz dialog is here.</p>
	</body>
</html>

 

zzz-dialog.js

//AJS.$(document).ready(function($) { // this variant never worked as well
AJS.bind("show.dialog", function(e, data) {
        alert("Dialog is initialized!"); // this alert is never shown :(
});

 

Thanks!

Answer
Watch
Like Be the first to like this
542 views

1 answer

0 votes
David Boyd
David Boyd
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 15, 2016

It looks like AJS is undefined 

I suggest including AUI resources in your html and then you can just do this in your javascript:

AJS.$(document).ready(function() {
   	alert("Dialog is initialized!");
});

 

View More Comments
CelesteCS
CelesteCS
Contributor
November 15, 2016

Hi David!

I've downloaded .ZIP archive from your article, copied it to /lib folder, updated my HTML, but still alert is not shown.

Here is an updated HTML:

<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
	<head>
		<meta charset="utf-8">
		<meta http-equiv="X-UA-Compatible" content="IE=EDGE">
		<link rel="stylesheet" href="/lib/aui/css/aui.min.css" media="all">
		<link rel="stylesheet" href="/lib/aui/css/aui-experimental.min.css" media="all">
		<script src="/lib/aui/js/aui.min.js"></script>
		<script src="/lib/aui/js/aui-experimental.min.js"></script>
		<script src="/lib/aui/js/aui-soy.min.js"></script>
		<script id="connect-loader" data-options="sizeToParent:true;">
			(function() {
			  var getUrlParam = function (param) {
			    var codedParam = (new RegExp(param + '=([^&]*)')).exec(window.location.search)[1];
			    return decodeURIComponent(codedParam);
			  };
			
			  var baseUrl = getUrlParam('xdm_e') + getUrlParam('cp');
			  var options = document.getElementById('connect-loader').getAttribute('data-options');
			
			  var script = document.createElement("script");
			  script.src = baseUrl + '/atlassian-connect/all.js';
			
			  if(options) {
			    script.setAttribute('data-options', options);
			  }
			  document.getElementsByTagName("head")[0].appendChild(script);
			})();
		</script>
	</head>
	<body style="background-color: #FFF">
		<p>Zzz dialog is here.</p>
	</body>
	<script src="/js/zzz-dialog.js"></script>	
</html>
Like
David Boyd
David Boyd
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 16, 2016

Hi Alexey,

Sorry, my answer above was dependant on serving AUI from CDN, to get your example to work with the downloaded AUI, you just need to include JQuery in your HTML. 

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
Like
CelesteCS
CelesteCS
Contributor
November 18, 2016

Still cannot make this sample work sad

Can anybody provide complete working code for everybody to use it?

Thanks!

Like
Reply

Suggest an answer

Log in or Sign up to answer
Confluence
Confluence
TAGS
AUG Leaders

Atlassian Community Events

    See all events