Provides access to Confluence web panels provided by other apps. The placeholder can be used to add all web panels for a given location, or specific ones identified by their plugin module keys.

By default all web panels from the k15t.scroll-viewport.viewcontent location are added. This can be changed by calling forLocation.

This placeholder can be used multiple times to include web panels from different locations or multiple individual web panels.

Methods

Name Type Description
$webPanels.forLocation(location) WebPanels

Returns or renders a web panels placeholder for the specified location with the default web panel context.

Returns: A web panels placeholder for all web panels from the specified location.

Parameter Type Description
location String A custom web panel location.
$webPanels.render() String

Renders this web panels placeholder with the default web panel context.

Returns: The HTML of all web panels represented by this placeholder.
$webPanels.render(customContext) String

Renders this web panels placeholder with the specified web panel context.

Returns: The HTML of all web panels represented by this placeholder.

Parameter Type Description
customContext Map<String,Object> A map of custom context objects that are passed to the web panels when they are rendered. The map keys must be strings. This extends the default context.
$webPanels.renderPanel(completeKey) String

Renders a single web panel with the default web panel context. The location of the specified web panel is ignored. The referenced web panel module must be enabled.

Returns: The HTML of the specified web panel.

Parameter Type Description
completeKey String The complete plugin module key (format: <pluginKey>:<moduleKey>) of the web panel.
$webPanels.renderPanel(completeKey, customContext) String

Renders a single web panel with the specified web panel context map. The location of the specified web panel is ignored. The referenced web panel module must be enabled.

Returns: The HTML of the specified web panel.

Parameter Type Description
completeKey String The complete plugin module key (format: <pluginKey>:<moduleKey>) of the web panel.
customContext Map<String,Object> A map of custom context objects that are passed to the web panel when it is rendered. The map keys must be strings. This extends the default context.
$webPanels.toString() String

Renders this web panels placeholder with the default web panel context.

Returns: The HTML of all web panels represented by this placeholder.