Skip to end of metadata
Go to start of metadata

This page is part of the Gadget Developers' JavaScript Cookbook.

What features are required for the framework?

In addition to our full list of features, below is a summary of the features used by the Atlassian Gadgets JavaScript Framework. It is safest just to include all of them:

Feature

Where Used

setprefs

To store gadget preferences.

views

To detect whether the user can edit the gadget preferences.

settitle

To automatically include the instance name in the title.

dynamic-height

Config screen,
View creation,
onResizeAdjustHeight

oauthpopup

Authentication.

#oauth

Authentication

auth-refresh

To automatically refresh the authentication of the gadget on a regular basis. Notes:

  • This feature is available in Atlassian Gadgets 1.1.3 and later versions of 1.1.x, and in 2.0.3 and all later versions.
  • You should use an <Optional> element to declare this feature, otherwise your gadget will not work in containers not based on Shindig.

atlassian.util

To detect whether the gadget is rendered by the same server it fetches data from, allowing retrieval optimisations. Note:

  • You should use an <Optional> element to declare this feature, otherwise your gadget will not work in non-Atlassian containers.

RELATED TOPICS

Including Features into your Gadget
Gadget Developers' JavaScript Cookbook
Using the Atlassian Gadgets JavaScript Framework

  • No labels