Skip to content

Commit 0a309e4

Browse files
sbruesekeSwen BrüsekeDaanHoogland
authored
Add detailed info regarding icon use (#454)
Co-authored-by: Swen Brüseke <[email protected]> Co-authored-by: dahn <[email protected]>
1 parent 5b9a2aa commit 0a309e4

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

source/adminguide/ui.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,19 +480,26 @@ Example for adding custom plugins:
480480
plugins: [
481481
{
482482
"name": "ExamplePlugin",
483-
"icon": "appstore",
483+
"icon": "appstore-outlined",
484484
"path": "example.html"
485485
},
486486
{
487487
"name": "ExamplePlugin1",
488-
"icon": "appstore",
488+
"icon": "appstore-outlined",
489489
"path": "https://cloudstack.apache.org/"
490490
}
491491
]
492492
...
493493
}
494494
495-
`icon` for the plugin can be chosen from Ant Design icons listed at `Icon - Ant Design Vue <https://www.antdv.com/components/icon/>`_.
495+
`icon` for the plugin can be chosen from Ant Design icons listed at `https://3x.antdv.com/components/icon <https://3x.antdv.com/components/icon>`_.
496+
497+
.. warning::
498+
Not all ant icons are supported at the moment. You will find a list of supported icons
499+
within the github repository in ui/src/core/lazy_lib/icons_use.js. To use an icon you
500+
need to transform the listed name. For example "PieChartOutlined" needs to be transformed
501+
to "pie-chart-outlined", "ReadOutlined" needs to be tranformed to "read-outlined".
502+
496503
For displaying a custom HTML in the plugin, HTML file can be stored in the CloudStack management server's web application directory on the server, i.e., */usr/share/cloudstack-management/webapp* and `path` can be set to the name of the file. For displaying a service or a web page, URL can be set as the `path` of the plugin.
497504

498505
|ui-custom-plugin.png|

0 commit comments

Comments
 (0)