Gadget Development

At heart, Atlassian gadgets are Google gadgets. Atlassian gadgets use the new Google gadgets.* API defined by the OpenSocial specification. In addition, you will probably want to use some of the Atlassian extensions to the gadget specification. You will also want to package your gadget as an Atlassian plugin, along with plugin modules that allow your gadget to interact with the Atlassian applications such as JIRA and Confluence.

Gadget Development Table of Contents

• Getting Started with Gadget Development
• Writing an Atlassian Gadget
  • Creating your Gadget XML Specification
    • Example of Gadget XML Specification
  • Using Substitution Variables and Directives in your Gadget
  • Allowing Configuration Options in your Gadget
  • Including Features into your Gadget
  • Packaging your Gadget as an Atlassian Plugin
  • Internationalising your Gadget
  • Using Web Resources in your Gadget
  • Using Atlassian REST APIs in your Gadget
  • Using the Atlassian Gadgets JavaScript Framework
    • Creating a Gadget JavaScript Object
      • Field Definitions
    • Gadget Object API
    • Gadget Developers' JavaScript Cookbook
      • Adding a Chart to the Issue Navigator
      • Adding a Reload Option to your Gadget
      • Adding Something to your Gadget Footer
      • Adjusting the Gadget Height when the Window is Resized
      • Making Ajax Calls
      • Making your Gadget Reload when Resized
      • Restricting Edit Permissions on your Gadget Preferences
      • Showing the Config Screen on Initial Load Only
      • Specifying Required Features for the Framework
      • Specifying Required Resources for the Framework
      • Theming your Gadget Dynamically
      • Using Authentication in your Gadget
      • Using Cookies in your Gadget
      • Using Special UserPrefs for the Framework
  • Running your Gadget in the Atlassian Reference Implementation
  • Managing Caching for your Gadget
• Gadget Containers
• Plugins Relevant to Gadget Development
• Examples of Gadgets
• Tutorials on Writing a Gadget
• Gadgets and JIRA Portlets

RELATED TOPICS

Reference Documents
Gadgets and Dashboards Documentation