django-jazzmin

The side menu is automatically generated from installed apps and models with admin classes.

• Use hide_apps (e.g., ['auth']) or hide_models (e.g., ['auth.user']) to omit items.
• Use order_with_respect_to to define the order. You can provide a full or partial list of apps, models, or custom link names.

Note: Custom links cannot be ordered via this setting.

# Order the auth app before the books app, other apps will be alphabetically placed after these
"order_with_respect_to": ["auth", "books"],

# Keep the same app ordering as above, but also order choice and book model links within the books app
"order_with_respect_to": ["auth", "books", "books.author", "books.book"],

# Just make sure auth is first
"order_with_respect_to": ["auth"],

# Order apps automatically, but make sure choice and book admin links are first within the books app
"order_with_respect_to": ["books.author", "books.book"],

# Place our choice model admin link and our custom link first within the books app
"order_with_respect_to": ["books.author", "Make Messages"],

To configure the general behavior of Jazzmin, define a JAZZMIN_SETTINGS dictionary in your Django settings file. This dictionary controls branding, menus, UI tweaks, and change form layouts.

JAZZMIN_SETTINGS = {
    "site_title": "Library Admin",
    "site_header": "Library",
    "site_brand": "Library",
    "site_logo": "books/img/logo.png",
    "login_logo": None,
    "login_logo_dark": None,
    "site_logo_classes": "img-circle",
    "site_icon": None,
    "welcome_sign": "Welcome to the library",
    "copyright": "Acme Library Ltd",
    "search_model": ["auth.User", "auth.Group"],
    "user_avatar": None,
    "topmenu_links": [
        {"name": "Home",  "url": "admin:index", "permissions": ["auth.view_user"]},
        {"name": "Support", "url": "https://github.com/farridav/django-jazzmin/issues", "new_window": True},
        {"model": "auth.User"},
        {"app": "books"},
    ],
    "usermenu_links": [
        {"name": "Support", "url": "https://github.com/farridav/django-jazzmin/issues", "new_window": True},
        {"model": "auth.user"}
    ],
    "show_sidebar": True,
    "navigation_expanded": True,
    "hide_apps": [],
    "hide_models": [],
    "order_with_respect_to": ["auth", "books", "books.author", "books.book"],
    "custom_links": {
        "books": [{
            "name": "Make Messages",
            "url": "make_messages",
            "icon": "fas fa-comments",
            "permissions": ["books.view_book"]
        }]
    },
    "icons": {
        "auth": "fas fa-users-cog",
        "auth.user": "fas fa-user",
        "auth.Group": "fas fa-users",
    },
    "default_icon_parents": "fas fa-chevron-circle-right",
    "default_icon_children": "fas fa-circle",
    "related_modal_active": False,
    "custom_css": None,
    "custom_js": None,
    "use_google_fonts_cdn": True,
    "show_ui_builder": False,
    "show_theme_chooser": False,
    "changeform_format": "horizontal_tabs",
    "changeform_format_overrides": {"auth.user": "collapsible", "auth.group": "vertical_tabs"},
    "language_chooser": True,
}

Jazzmin overrides Django templates, which can lead to many strings appearing as untranslated. When adding a new language, follow this workflow to ensure you only include strings unique to Jazzmin and avoid duplicating Django's built-in translations:

1. Navigate to the jazzmin folder.
2. Create the language directory structure (e.g., locale/de/LC_MESSAGES).
3. Run django-admin makemessages to extract strings.
4. Return to the project root.
5. Run the pruning command: ./cli.py locales --prune <lang_code> (e.g., ./cli.py locales --prune de) to remove strings already provided by Django.
6. Review the remaining strings. If any are not unique to Jazzmin, find them in the codebase and ensure they match the exact strings used in Django's admin translation files.
7. Repeat makemessages until the file contains only unique Jazzmin strings.

# Example for German (de)
cd jazzmin
mkdir -p locale/de/LC_MESSAGES
django-admin makemessages
cd ../
./cli.py locales --prune de