Pass ChangeInfo to change-metadata-item plugin endpoint
This grants access for plugin-provided elements to the currently displayed change. Change-Id: Ie3b0ef1ab2ab6bb9e4eb8c26c5a3e73e271c642e
This commit is contained in:
parent
12f452384c
commit
73789218ab
@ -1,7 +1,5 @@
|
|||||||
= Gerrit Code Review - PolyGerrit Plugin Styling
|
= Gerrit Code Review - PolyGerrit Plugin Styling
|
||||||
|
|
||||||
== Plugin endpoints
|
|
||||||
|
|
||||||
Plugin should be html-based and imported following PolyGerrit's
|
Plugin should be html-based and imported following PolyGerrit's
|
||||||
link:pg-plugin-dev.html#loading[dev guide].
|
link:pg-plugin-dev.html#loading[dev guide].
|
||||||
|
|
||||||
@ -20,6 +18,23 @@ Gerrit.install(plugin => {
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
== Default parameters
|
||||||
|
All endpoints receive the following params, set as attributes to custom components
|
||||||
|
that are instantiated at the endpoint:
|
||||||
|
|
||||||
|
* `plugin`
|
||||||
|
+
|
||||||
|
the current plugin instance, the one that is used by `Gerrit.install()`.
|
||||||
|
|
||||||
|
* `content`
|
||||||
|
+
|
||||||
|
decorated DOM Element, is only set for registrations that decorate existing
|
||||||
|
components.
|
||||||
|
|
||||||
|
== Plugin endpoints
|
||||||
|
|
||||||
|
Following endpoints are available to plugins
|
||||||
|
|
||||||
=== change-view-integration
|
=== change-view-integration
|
||||||
Extension point is located between `Files` and `Messages` section on the change
|
Extension point is located between `Files` and `Messages` section on the change
|
||||||
view page, and it may take full page's width. Primary purpose is to enable
|
view page, and it may take full page's width. Primary purpose is to enable
|
||||||
@ -30,3 +45,10 @@ Extension point is located on the bottom of the change view left panel, under
|
|||||||
`Label Status` and `Links` sections. It's width is equal to the left panel's and
|
`Label Status` and `Links` sections. It's width is equal to the left panel's and
|
||||||
primary purpose is to enable plugins to add sections of metadata to the left
|
primary purpose is to enable plugins to add sections of metadata to the left
|
||||||
panel.
|
panel.
|
||||||
|
|
||||||
|
In addition to default parameters, the following are available:
|
||||||
|
|
||||||
|
* `change`
|
||||||
|
+
|
||||||
|
current change displayed, an instance of
|
||||||
|
link:rest-api-changes.html#change-info[ChangeInfo]
|
||||||
|
@ -329,6 +329,7 @@ limitations under the License.
|
|||||||
</span>
|
</span>
|
||||||
</section>
|
</section>
|
||||||
<gr-endpoint-decorator name="change-metadata-item">
|
<gr-endpoint-decorator name="change-metadata-item">
|
||||||
|
<gr-endpoint-param name="change" value="[[change]]"></gr-endpoint-param>
|
||||||
</gr-endpoint-decorator>
|
</gr-endpoint-decorator>
|
||||||
</gr-external-style>
|
</gr-external-style>
|
||||||
<gr-rest-api-interface id="restAPI"></gr-rest-api-interface>
|
<gr-rest-api-interface id="restAPI"></gr-rest-api-interface>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user