Skip to main content

treewidget for django admin

Project description

Provides the model fields TreeForeignKey, TreeOneToOneField, TreeManyToManyField for tree models with a tree widget for django. Uses jstree (thanks to vakata).

Tested with django-mptt and django-treebeard with Django 1.11 & 2.0.2. It will not work with Django <1.11.

Installation

  • pip install django-treewidget

  • place 'treewidget' in INSTALLED_APPS

  • for AJAX tree updates add the routes to your urls.py, e.g. url(r'^treewidget/', include('treewidget.urls'))

Usage

Just replace any foreign key, m2m or one2one tree model field with the provided counterpart.

Customization

The fields understand two additional arguments:

  • settings: Dictionary containing the optional boolean values for ‘show_buttons’ (shows “Expand”, “Collapse” and “Selected” buttons), ‘search’ (for in-tree search), ‘dnd’ (drag and drop support) and ‘sort’ (apply tree order in frontend). Defaults to {}.

  • treeoptions: Settings directly applied to jstree. Must be a JSON string, if given as argument to a field, otherwise a python dictionary. Defaults to treewidget.fields.TREEOPTIONS. Note that some widget settings will override treeoptions to keep working.

Both settings can be provided project wide in settings.py as TREEWIDGET_SETTINGS and TREEWIDGET_TREEOPTIONS.

NOTE: To be able to render a correct tree structure the widget code checks for missing ancestors and adds left out nodes. To keep in sync with the real queryset (used for the underlying select options) added nodes are not selectable. Don not use this app if you filter against row based read permissions since it might reveal confident data. This behavior might change with future versions.

Example

from django.db import models
from mptt.models import MPTTModel
from treewidget.fields import TreeForeignKey

class Mptt(MPTTModel):
    name = models.CharField(max_length=32)
    parent = TreeForeignKey('self', blank=True, null=True, on_delete=models.CASCADE)

    def __str__(self):
        return self.name

Renders like this:

screenshot

screenshot

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

django-treewidget-0.2.3.tar.gz (135.6 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