nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-05-20 10:34:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

menu: Update documentation to clarify that icons can be files

Browse Source 
Closes: #1915.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Joseph Nuthalapati <njoseph@riseup.net>
This commit is contained in:
Sunil Mohan Adapa 2020-08-20 11:13:24 -07:00 committed by Joseph Nuthalapati
parent 2ada14ccdb
commit 6c143090ae
No known key found for this signature in database
GPG Key ID: 5398F00A2FA43C35
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
plinth/menu.py
View File

@ -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