Menu#
- class plinth.menu.Menu(component_id: str, name: str | None = None, icon: str | None = None, tags: list[str] | None = None, url_name: str | None = None, url_args: list | None = None, url_kwargs: dict | None = None, parent_url_name: str | None = None, order: int = 50, advanced: bool = False)[source]#
Component to manage a single menu item.
- __init__(component_id: str, name: str | None = None, icon: str | None = None, tags: list[str] | None = None, url_name: str | None = None, url_args: list | None = None, url_kwargs: dict | None = None, parent_url_name: str | None = None, order: int = 50, advanced: bool = False)[source]#
Initialize a new menu item with basic properties.
name is the label of the menu item.
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 plinth/modules/<app>/static/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 ‘myicon’ and app_id in App class is ‘myapp’, then two icons files plinth/modules/myapp/static/icons/myicon.svg and plinth/modules/myapp/static/icons/myicon.png are used in the interface.
tags is a list of tags that describe the app. Tags help users to find similar apps or alternatives and discover use cases.
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 are sent to reverse() when resolving url from url_name.
parent_url_name optionally specifies the menu item under which this menu item should become a child.
order is the numerical rank of this item within the menu. Lower order items appear closest to the top/left of the menu. By convention, we use the spectrum between 0 and 100 to rank orders, but feel free to disregard that. If you need more granularity, don’t bother renumbering things. Feel free to use fractional orders.
advanced decides whether to show the menu item only in advanced mode.
- static get_with_url_name(url_name: str) → Menu[source]#
Return a menu item with given URL name.
Raise LookupError of the request item is not found.
- property items#
Return the list of children for this menu item.