summaryrefslogtreecommitdiffstats
path: root/Documentation/pg-plugin-admin-api.txt
blob: 1c724d0cd0f79b67b03153c78cb4b1ede784fe40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
= Gerrit Code Review - Admin customization API

This API is provided by link:pg-plugin-dev.html#plugin-admin[plugin.admin()]
and provides customization of the admin menu.

== addMenuLink
`adminApi.addMenuLink(text, url, opt_external)`

Add a new link to the end of the admin navigation menu.

.Params
- *text* String text to appear in the link.
- *url* String of the destination URL for the link.

When adding an external link, the URL provided should be a full URL. Otherwise,
a non-external link should be relative beginning with a slash. For example, to
create a link to open changes, use the value `/q/status:open`.