TeamCity Plugin Development Help
 

Controlled UI Plugins

Edit page Last modified: 04 January 2023

This guide explains how to create a controlled UI plugin based on the new front-end extensions paradigm.

Source branch with the example project: example/controlled-plugin.

The name controlled explains the main advantage of these plugins – a developer controls the plugin behavior. A controlled plugin knows how to react on the lifecycle events. It uses the Plugin API to update its content, to subscribe and unsubscribe to events, and to abort requests. In other words, controlled plugins allow creating rich applications within the TeamCity UI. Moreover, when the Plugin Wrapper knows that a plugin is controlled by a developer, it stops requesting the plugin content every time and reduce lifecycle events.