Skip to main content
PyPI version build-status coverage

MOJO NAVIGATION

This Django app manages navigations trees with simple features. It is highly inspired by django-treenav and django-sitetree. It offers a lighter version to allow easy customisation.

The trees structure is using mptt. Each item offer various options to generate the url, restrict access given user status and permissions, classes and behaviours.

Changelist view:

https://box.everhelper.me/attachment/342272/1VqyhRX5tQTX7AFhZZpY6HdPzrPh3QmW/341506-7MaquApmPbU02vSZ/screen.png

Add view:

https://box.everhelper.me/attachment/342274/1VqyhRX5tQTX7AFhZZpY6HdPzrPh3QmW/341506-JJ7ps4S6TNfi1DI6/screen.png

Install

It is strongly recommanded to install this theme from GIT with PIP onto you project virtualenv.

From PyPi

pip install mojo-navigation

From Github

https://github.com/django-mojo/mojo-navigation#egg=mojo-navigation

setup

This application works with django mptt module in order to display the trees. It is highly recommended to add it in the INSTALLED_APPS.

INSTALLED_APPS = (
    ...
    'django_mptt'
    ...
)

If you want to use the default model and admin, also install the module itself.

INSTALLED_APPS = (
    ...
    'mojo.navigation'
    ...
)

Then install your model with

python manage.py syncdb

In case you are using South, you can alternatively do:

python manage.py migrate mojo.navigation

Managers

There are 2 main managers to help sortting and filtering the menu items.

Tree

You can get all items of a specific tree by passing its slug in the for_tree manager, for exemple:

tree_items = Item.objects.for_slug('slug_exemple')

User

As we are using permissions for items. You can filter items for a specific user to retrieve all the items he has access to by passing its object in the for_user manager, for exemple:

tree_items = Item.objects.for_user(request.user)

Utils

level

You can limit the number of tree levels of trees. For exemple, some menus can be one or two levels only. In such case its useless to allow the the user to add more.

In order to limit the number of levels you need to create a custom admin class inheriting from mojo.navigation.admin.ItemAdmin and add a level_limit attribute with the desired value.

For exemple, this will limit the tree to two levels:

from mojo.navigation.admin import ItemAdmin

class CustomItemAdmin(ItemAdmin):
    level_limit = 1

Contribution

Please feel free to contribute. Any help and advices are much appreciated.

Metadata

Release files for mojo-navigation 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mojo-navigation 0.0.3
File Size Uploaded
mojo-navigation-0.0.3.tar.gz 9.6 kB Details

Release files / mojo-navigation-0.0.3.tar.gz

Download URL mojo-navigation-0.0.3.tar.gz
Size 9.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d27ce64447d3da0ed467b3e98e39761c2e2de3697db9164143217666449a2a33
BLAKE2b-256 checksum
How to use checksums
9bc14ddefb731454ed8567f0766ffeceed5e805f1ad85f775144eff446e4b99a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.3 This release

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page