JIRA notification messages

Ever wondered how the nice little JIRA notification messages are created? The ones you get when an issue is created in JIRA?

Doing this is so easy that you will want to try it out in every new plugin that you write!

All you need is to inject the following javascript snippet into the page:

JIRA.Messages.showSuccessMsg('Your message goes here');

Let me show you a simple demonstration of this. I am going to put this into the announcement banner so that I don't have to create a plugin to inject this javascript ;)

Let us say we need to show this message when a user visits the profile. All you need to do is to add this snippet in the Announcement banner.

<script >
var pathname = window.location.pathname;
if (pathname.indexOf("ViewProfile.jspa") >= 0)
{
   JIRA.Messages.showSuccessMsg('You are viewing your profile, Success');
}
</script>

And the message will appear on the screen when you visit the profile.

But, did you notice that the message didn't have a close button as you normally see in the Create notification? This is where you can pass properties to the function.

<script >
var pathname = window.location.pathname;
if (pathname.indexOf("ViewProfile.jspa") >= 0)
{
   JIRA.Messages.showSuccessMsg('You are viewing your profile', {closeable: true});
}
</script>

Here we passed the closeable property to the same function and the message will now have a close option.

Now, you can replace the showSuccessMsg function with showErrorMsg or showWarningMsg to get the appropriate message format.

ERROR

WARNING

In all the 3 cases, the message disappears itself after the default timeout of 10 seconds. If you need a bigger timeout, use the timeout property.

<script >
var pathname = window.location.pathname;
if (pathname.indexOf("ViewProfile.jspa") >= 0)
{
   JIRA.Messages.showSuccessMsg('You are viewing your profile', {closeable: true, timeout: 60});
}
</script>

Are there any other properties? The only other property is type and you can use it when you use the generic function showMsg instead of showSuccessMsg, showErrorMsg or showWarningMsg. The possible type values are SUCCESS, ERROR or WARNING.

For example:

JIRA.Messages.showSuccessMsg('You are viewing your profile', {closeable: true, timeout: 60});

is same as

JIRA.Messages.showMsg('You are viewing your profile', {type: SUCCESS, closeable: true, timeout: 60});

For more details on how these functions work and for more more useful functions like showReloadSuccessMsg, take a look at includes/jira/common/messages.js file. Hope you find it useful.

PS: If you find these little tutorials useful, you might also like the JIRA Development Cookbook.