Getting Started

Note

Django JET Dashboard tries to be as compatible as possible with django-admin-tools dashboard so that django-admin-tools modules could be easily ported to Django JET. In most cases in will be enough to change python imports and remove extending in modules templates.

Dashboard represents Dashboard class instance with DashboardModule class instances as its children. Any custom Dashboard class should inherit jet.dashboard.dashboard.Dashboard and use init_with_context to fill it with widgets. You should add your widgets to children and available_children attributes.

Set Up Custom Dashboard

• Create dashboard.py in any suitable location (e.g., in your project root) with the following content:

  from django.utils.translation import ugettext_lazy as _
  from jet.dashboard import modules
  from jet.dashboard.dashboard import Dashboard, AppIndexDashboard
  
  
  class CustomIndexDashboard(Dashboard):
      columns = 3
  
      def init_with_context(self, context):
          self.available_children.append(modules.LinkList)
          self.children.append(modules.LinkList(
              _('Support'),
              children=[
                  {
                      'title': _('Django documentation'),
                      'url': 'http://docs.djangoproject.com/',
                      'external': True,
                  },
                  {
                      'title': _('Django "django-users" mailing list'),
                      'url': 'http://groups.google.com/group/django-users',
                      'external': True,
                  },
                  {
                      'title': _('Django irc channel'),
                      'url': 'irc://irc.freenode.net/django',
                      'external': True,
                  },
              ],
              column=0,
              order=0
          ))
  

• Add to your settings.py path to created dashboard.py (example for dashboard.py in project root):

JET_INDEX_DASHBOARD = 'dashboard.CustomIndexDashboard'

That’s all, now you have dashboard with only one widget - LinkList. Dashboard reset may be needed if your had another dashboard already rendered for any user. Visit Dashboard modules to learn other widgets you can add to your custom dashboard or create your own.