diff options
Diffstat (limited to 'Documentation/pg-plugin-admin-api.txt')
| -rw-r--r-- | Documentation/pg-plugin-admin-api.txt | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/Documentation/pg-plugin-admin-api.txt b/Documentation/pg-plugin-admin-api.txt new file mode 100644 index 0000000000..1c724d0cd0 --- /dev/null +++ b/Documentation/pg-plugin-admin-api.txt @@ -0,0 +1,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`.
\ No newline at end of file |