From 6c143090ae4dc72e74e3b9e1a0b2bad6a4d9f0d5 Mon Sep 17 00:00:00 2001 From: Sunil Mohan Adapa Date: Thu, 20 Aug 2020 11:13:24 -0700 Subject: [PATCH] menu: Update documentation to clarify that icons can be files Closes: #1915. Signed-off-by: Sunil Mohan Adapa Reviewed-by: Joseph Nuthalapati --- plinth/menu.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/plinth/menu.py b/plinth/menu.py index ea7d31387..97c811c7e 100644 --- a/plinth/menu.py +++ b/plinth/menu.py @@ -19,8 +19,15 @@ class Menu(app.FollowerComponent): short_description is an optional description shown on the menu item. - icon is the icon to be displayed for the menu item. Choose from the - Fork Awesome set: https://forkawesome.github.io/Fork-Awesome/icons/ + icon is the icon to be displayed for the menu item. Icon can be the + name of a glyphicon from the Fork Awesome font's icon set: + https://forkawesome.github.io/Fork-Awesome/icons/. In this case, the + icon name starts with the string 'fa-'. Alternatively, the icon can + also be a file under the directory static/theme/icons/, provided + without an extension. SVG icons are preferred. Currently, both PNG and + SVG icons with the same name are used. For example, if the value of + icon is 'myapp', then two icons files static/theme/icons/myapp.svg and + static/theme/icons/myapp.png are used in the interface. url_name is the name of url location that will be activated when the menu item is selected. This is not optional. url_args and url_kwargs