Skip to main content

A Django admin theme with a horizontal, tabbed navigation bar

Project description

Django Admin Menu Theme

An alternative theme for the Django admin that has a horizontal navigation bar with drop down menus for your models. Fully themeable from settings.py.

Downloads

screenshot

Installation

Install the package:

pip install django-admin-menu

Then add admin_menu to your INSTALLED_APPS setting, before django.contrib.admin (or it wont work). For example:

INSTALLED_APPS = [
    'admin_menu',
    'django.contrib.admin',
    ...
]

Settings

There are a couple of options you can adjust in your settings.py to influence the theme.

To adjust the logo, change:

ADMIN_LOGO = 'logo.png'

The logo is used in the top left of each page and on the login page.

You can adjust the order of the menu items with the MENU_WEIGHT setting:

MENU_WEIGHT = {
    'World': 20,
    'Auth': 4,
    'Sample': 5
}

Items with a higher weight will be pushed to the end of the menu. You don't have to fill in all the menu items, just the ones you would like to adjust the position of.

ModelAdmin Settings

There are a few settings on your ModelAdmin class to adjust the menu:

class MyAdmin(admin.ModelAdmin):
    menu_title = "Users"
    menu_group = "Staff"

will change the title for this model to Users and place it on a drop down titled Staff.

You can use the same menu_group on multiple ModelAdmin classes and they will be grouped on the same menu.

Screenshots

screenshot screenshot screenshot

Theming

To adjust the theme, you can add and edit these options in your project's settings.py file:

ADMIN_STYLE = {
    'primary-color': '#164B36',
    'secondary-color': '#092117',
    'tertiary-color': '#51B48E'
}

These variables are usually enough to add a brand flavour to the admin. There are other variables you can add, to change text colour etc. These are listed under Custom Theme.

Dark Theme

screenshot

Add to your settings.py:

ADMIN_STYLE = {
    'primary-color': '#2B3746',
    'secondary-color': '#354151',
    'tertiary-color': '#F2F9FC'
}

Django Theme

screenshot

Add to your settings.py:

ADMIN_STYLE = {
    'primary-color': '#164B36',
    'secondary-color': '#092117',
    'tertiary-color': '#51B48E'
}

Red Theme

screenshot

Add to your settings.py:

ADMIN_STYLE = {
    'primary-color': '#B42D33',
    'secondary-color': '#000000',
    'tertiary-color': '#333333'
}

Custom Themes

You can customise the theme however you like, using these available variables:

ADMIN_STYLE = {
    'background': 'white',
    'primary-color': '#205280',
    'primary-text': '#d6d5d2',
    'secondary-color': '#3B75AD',
    'secondary-text': 'white',
    'tertiary-color': '#F2F9FC',
    'tertiary-text': 'black',
    'breadcrumb-color': 'whitesmoke',
    'breadcrumb-text': 'black',
    'focus-color': '#eaeaea',
    'focus-text': '#666',
    'primary-button': '#26904A',
    'primary-button-text':' white',
    'secondary-button': '#999',
    'secondary-button-text': 'white',
    'link-color': '#333',
    'link-color-hover': 'lighten($link-color, 20%)',
    'logo-width': 'auto',
    'logo-height': '35px'
}

History

[1.0] - 2016-12-05

First release, works.

[1.1] - 2016-12-16

Added theming support.

[1.2] - 2020-04-06

  • Added support for Django 3.0+.
  • Made the ADMIN_LOGO setting optional.
  • Allowed adjusting admin logo size with logo-width and logo-height style settings.

[1.3] - 2020-06-27

  • Reworked the pagination style to look more inline with the table style
  • Fixed an issue where the verbose_name from the AppConfig class wasn't used in the menu

[1.4] - 2020-11-16

  • Fixed a bug where the Dashboard icon would be highlighted even if another tab was active
  • Display the admin title as text if no logo is defined in the settings

[1.5] - 2021-02-14

  • Fixed compatibility with Django 3+ (thanks to arturgsb)

[1.6] - 2022-02-01

  • Fixed compatibility with Django 4
  • Added support for Django's view permission (thanks @cobia)
  • Fixed menu height on mobile (thanks @mojek)

[unreleased]

License

MIT

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-admin-menu-1.6.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

django_admin_menu-1.6-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file django-admin-menu-1.6.tar.gz.

File metadata

  • Download URL: django-admin-menu-1.6.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.10

File hashes

Hashes for django-admin-menu-1.6.tar.gz
Algorithm Hash digest
SHA256 a5e5960d072534a7bf7fb1a94210389dd9ceaabbbe49c46152ba62d7069e8ef1
MD5 3b986ac898b6cfd81d5237577bab56db
BLAKE2b-256 b5d8a9d95c3720dbafb1153c89a13a1f43302ca6fab1f202055b299bd535ad55

See more details on using hashes here.

File details

Details for the file django_admin_menu-1.6-py3-none-any.whl.

File metadata

  • Download URL: django_admin_menu-1.6-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.10

File hashes

Hashes for django_admin_menu-1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ca4bd86f52503f05de3632665abd1578d518ee36f420059f330d6796d2ddf91a
MD5 fa6e01c1885969877bd662a15cf2ccad
BLAKE2b-256 2ae5775f57de094f36e372a417d5287db12d09a22c4cd38d71dc2faf1a88a37c

See more details on using hashes here.

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