Unofficial extra for Django Unfold Admin. Supports django-parler and django-cms.
Project description
Django Unfold Extra
Unofficial extension for Django Unfold Admin. Adds support for django-parler and django-cms to the modern and clean Django Unfold admin interface.
Overview
Django Unfold Extra enhances the Django Unfold admin interface with additional functionality for:
- django-cms: Integration with Django CMS 5.0, including Unfold colors in the CMS admin
- django-parler: Multilingual support for your Django models
- versatile-image: Improved integration with django-versatileimagefield, including preview and ppoi
- Unfold auto-update: Styles can be updated from the official Unfold package via npm
- Theme-Sync: Use either Unfold or Django CMS switcher to control themes. You can run both at the same time, with or without both controls enabled.
This package maintains the clean, modern aesthetic of Django Unfold while adding specialized interfaces for these popular Django packages.
It uses unobtrusive template and CSS-styling overrides where possible. As Django CMS uses many '!important' flags, pagetree.css had to be rebuilt from sources to remove some conflicting style definitions.
Note: Django CMS support is not fully tested yet. Filer integration is not supported.
Installation
-
Install the package via pip:
pip install django-unfold-extra
-
Add to your INSTALLED_APPS in settings.py:
INSTALLED_APPS = [
# Unfold theme
"unfold",
"unfold_extra",
# Optional integrations
"unfold_extra.contrib.cms",
"unfold_extra.contrib.parler",
"unfold_extra.contrib.auth", # you will likely want a custom auth admin
"unfold_extra.contrib.sites",
]
Make sure you have already configured Django Unfold and any optional upstream packages you use such as django CMS and django-parler.
Add the following to your settings.py:
from django.templatetags.static import static
UNFOLD = {
"STYLES": [
lambda request: static("unfold_extra/css/styles.css"), # additional styles for supported integrations
],
"SCRIPTS": [
lambda request: static("unfold_extra/js/theme-sync.js"), # keep django CMS theme in sync with Unfold
],
}
CMS_COLOR_SCHEME_TOGGLE = False # optional: let Unfold be the single theme switch
# Move the CMS "New Page" button into Unfold's header (default: True).
# Set to False to keep the button in the CMS pagetree body.
UNFOLD_CMS_HEADER_ADD_BUTTON = True
Language sync (Unfold ↔ CMS)
To keep the Unfold language switcher and the CMS toolbar/admin in sync, register
cms_set_language from unfold_extra.views as the set_language URL
before Django's i18n URLs:
from unfold_extra.views import cms_set_language
urlpatterns = [
path("i18n/setlang/", cms_set_language, name="set_language"),
path("i18n/", include("django.conf.urls.i18n")),
# ...
]
When a user switches language via Unfold's sidebar, cms_set_language updates
the CMS UserSettings.language before the redirect so the CMS toolbar renders
in the same language on the next request.
Add {% unfold_extra_styles %} and {% unfold_extra_theme_sync %} from unfold_extra_tags
to your base HTML template.
- Enables Unfold admin colors in django CMS
- Syncs the Unfold theme with django CMS (light/dark/auto)
{% load static cms_tags sekizai_tags unfold_extra_tags %}
<!DOCTYPE html>
<html>
<head>
<title>{% block title %}{% endblock title %}</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% render_block "css" %}
{% unfold_extra_styles %}
{% unfold_extra_theme_sync %}
...
</head>
...
</html>
Usage
django-parler Support
- UnfoldTranslatableAdminMixin
- UnfoldTranslatableStackedAdminMixin
- UnfoldTranslatableTabularAdminMixin
- TranslatableStackedInline, TranslatableTabularInline
Example use:
class TranslatableAdmin(UnfoldTranslatableAdminMixin, BaseTranslatableAdmin):
"""custom translatable admin implementation"""
# ... your code
class MyInlineAdmin(TranslatableStackedInline):
model = MyModel
tab = True # Unfold inline settings
extra = 0 # django inline settings
django-cms Support
- Theme integration in django admin (partial support in frontend)
- Pagetree
- PageUser, PageUserGroup, GlobalPagePermission when
CMS_PERMISSION = True - djangocms-versioning admin template and styling support
- CMS UserSettings singleton admin navigation and submit row
- "New Page" button in Unfold header position (configurable via
UNFOLD_CMS_HEADER_ADD_BUTTON) - Modal support
- Not supported: Filer
Support is automatically applied. Currently, it does not support customization besides compiling your own unfold_extra styles.
Frontend django CMS support
Add unfold_extra_tags to your base HTML template after loading all CSS styles.
This adds additional styles to integrate django CMS with Unfold Admin and exposes "COLORS" from Unfold settings on
the public website for authenticated django-cms admin users.
{% load cms_tags sekizai_tags unfold_extra_tags %}
<head>
...
{% render_block "css" %}
{% unfold_extra_styles %}
...
</head>
Custom compilation via npm/pnpm
The current frontend scripts live in unfold_extra/src/package.json. Run them from
unfold_extra/src, for example:
npm run update:unfold
npm run tailwind:build
npm run tailwind:watch
npm run build:js
Sync CMS pagetree CSS after upgrading django-cms
The CMS pagetree CSS is vendored with Unfold compatibility patches (e.g. removing the bare .hidden selector
that conflicts with Tailwind/Unfold sidebar). After upgrading django-cms, re-sync the patched CSS:
poetry run python scripts/sync_cms_pagetree.py
The script will warn if any patch targets have changed upstream and need manual review.
Change colors for Django CMS
You can change the colors for django CMS by editing unfold_extra/src/css/unfold_extra.css
or by updating the Unfold colors in settings.py.
- Change into
unfold_extra/src - Fetch the latest Unfold version using
npm run update:unfold - Rebuild styles with
npm run tailwind:buildor usenpm run tailwind:watchwhile iterating
html:root {
--dca-light-mode: 1;
--dca-dark-mode: 0;
--dca-white: theme('colors.white');
--dca-black: theme('colors.black');
--dca-shadow: theme('colors.base.950');
--dca-primary: theme('colors.primary.600');
--dca-gray: theme('colors.base.500');
--dca-gray-lightest: theme('colors.base.100');
--dca-gray-lighter: theme('colors.base.200');
--dca-gray-light: theme('colors.base.400');
--dca-gray-darker: theme('colors.base.700');
--dca-gray-darkest: theme('colors.base.800');
--dca-gray-super-lightest: theme('colors.base.50');
--active-brightness: 0.9;
--focus-brightness: 0.95;
}
html.dark {
--dca-light-mode: 0;
--dca-dark-mode: 1;
--dca-white: theme('colors.base.900');
--dca-black: theme('colors.white');
--dca-primary: theme('colors.primary.500');
--dca-gray: theme('colors.base.300') !important;
--dca-gray-lightest: theme('colors.base.700');
--dca-gray-lighter: theme('colors.base.600');
--dca-gray-light: theme('colors.base.400');
--dca-gray-darker: theme('colors.base.200');
--dca-gray-darkest: theme('colors.base.100');
--dca-gray-super-lightest: theme('colors.base.800');
--active-brightness: 2;
--focus-brightness: 1.5;
}
Versatile Image Support
- Improved unfold integration via CSS only.
Django Auth, Sites
- Adds Unfold-based admin registrations for
django.contrib.authanddjango.contrib.sites.
This is for personal use. You likely want to customize this.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_unfold_extra-0.1.13.tar.gz.
File metadata
- Download URL: django_unfold_extra-0.1.13.tar.gz
- Upload date:
- Size: 56.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
708cdcbc0cdc6133da244d553dcd153c55b90805a9574255c2d4a34332520f85
|
|
| MD5 |
a9ce0574b19fad516ce3b495d8f314fb
|
|
| BLAKE2b-256 |
6c360c724c305c4e6a9866dd0db305af72dfab5ab6ee70bb880964c0b4fb73af
|
File details
Details for the file django_unfold_extra-0.1.13-py3-none-any.whl.
File metadata
- Download URL: django_unfold_extra-0.1.13-py3-none-any.whl
- Upload date:
- Size: 66.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0417fd4a9ddbef68da2f71ed1a86c451d0cf510ee0d015efede170bf0243db0b
|
|
| MD5 |
71ccf2e615c88a06ad11c0d08e981223
|
|
| BLAKE2b-256 |
fbc536e19f1e3de09f438c96eba72bfcd4b851288ab4b55d4d1eb42e10cb4d1c
|