Skip to main content

Dolmen menus composer

Project description

dolmen.menu aims to provide the most flexible and explicit way to create and manage menus and their entries with Grok.

You have to know that…

  • dolmen.menu only works on Python 2.6.

  • dolmen.menu does not support sub-menus, out of the box. The implementation is left to your discretion.

Components

dolmen.menu provides two components:

  • Menu : the menu implementation is based on the zope “content provider” notion and is using the grokcore.viewlet package.

  • Entry: a menu item is called an entry. It’s a multi adapter that is registered for a Menu component.

Examples

A menu component:

>>> from dolmen import menu

>>> class MyMenu(menu.Menu):
...     menu.title('My nice menu')

A menu entry:

>>> class MyMenuEntry(menu.Entry):
...     menu.order(1)
...     menu.name('a_direct_entry')
...     menu.title('My Entry')
...     menu.menu(MyMenu)

Registration

In order to use base Grok component as menu entries, we get two registration ways.

class decorator

A class decorator allows you to decorate any class, in order to register it as a menu entry:

>>> import grokcore.view

>>> @menu.menuentry(MyMenu)
... class TestEntry(grokcore.view.View):
...    def render(self):
...        return u"A simple entry"

Module level martian directive

A martian directive allows you register classes you can’t decorate (from a foreign package, for instance), explicitly:

>>> class SomeView(grokcore.view.View):
...    def render(self):
...        return u"I'm a view and I want to be a menu entry"

>>> menu.global_menuentry(SomeView, MyMenu, order=2)

Changes

0.2 (2010-03-05)

  • Changed the way to fetch the menu CSS id.

0.1 (2010-03-03)

  • Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dolmen.menu-0.2.tar.gz (9.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page