blob: 985809da504540a183ee4a56021ffdc5687b2ed2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
= Gerrit Code Review - Settings admin customization API
This API is provided by link:pg-plugin-dev.html#plugin-settings[plugin.settings()]
and provides customization to settings page.
== title
`settingsApi.title(title)`
.Params
- `*string* title` Menu item and settings section title
.Returns
- `GrSettingsApi` for chaining.
== token
`settingsApi.token(token)`
.Params
- `*string* token` URL path fragment of the screen for direct link, e.g.
`settings/#x/some-plugin/*token*`
.Returns
- `GrSettingsApi` for chaining.
== module
`settingsApi.module(token)`
.Params
- `*string* module` Custom element name for instantiating in the settings plugin
area.
.Returns
- `GrSettingsApi` for chaining.
== build
.Params
- none
Apply all other configuration parameters and create required UI elements.
|
