Menu plugin¶
Plugin for Django CMS QE providing menu. It allows include menu at any place so it can be moved without support of developers.
Usage¶
Add plugin from section Generic called Menu. When used, you are asked which page you want to use as top of the menu tree. That is set by page ID in advanced setting. Also how deep it menu should be. Keep in mind that normally menu supports only one level because on mobile devices are deeper menus harder to use. Use deeper level only when your design supports it.
API¶
-
class
cms_qe_menu.cms_plugins.MenuPlugin(model=None, admin_site=None)[source]¶ CMS plugin allowing to add menu at any place.
-
form¶ alias of
django.forms.widgets.MenuPluginForm
-
model¶ alias of
cms_qe_menu.models.MenuPluginModel
-
-
class
cms_qe_menu.models.MenuPluginModel(id, path, depth, numchild, placeholder, parent, position, language, plugin_type, creation_date, changed_date, cmsplugin_ptr, orientation, start_page, end_level, submenu_in_inactive_item)[source]¶ Parameters: - id (AutoField) –
- path (CharField) –
- depth (PositiveIntegerField) –
- numchild (PositiveIntegerField) –
- placeholder_id (ForeignKey to
Placeholder) – - parent_id (ForeignKey to
CMSPlugin) – - position (PositiveSmallIntegerField) –
- language (CharField) –
- plugin_type (CharField) –
- creation_date (DateTimeField) –
- changed_date (DateTimeField) –
- cmsplugin_ptr_id (OneToOneField to
CMSPlugin) – - orientation (IntegerField) –
- start_page (CharField) – ID of page in advanced settings.
- end_level (IntegerField) – Specify at which level the navigation should stop. Keep in mind that Bootstrap by default does not support dropdown submenu. Any deep dropdown menu is not very well accessible from mobile devices.
- submenu_in_inactive_item (BooleanField) –
-
exception
DoesNotExist¶
-
exception
MultipleObjectsReturned¶
-
extra_active¶ Fourth parameter of tag show_menu of Django CMS. Specifies how many sub items should be displayed when item is active.
For vertical menu is good for users to show only one more level, for horizontal with dropdown is possible to show all to same deep level admin want to users to be able to go.
-
extra_inactive¶ Third parameter of tag show_menu of Django CMS. Specifies how many sub items should be displayed when item is not active.
Admin can choose if he wants to show everything or nothing.