Unofficial extra for Django Unfold Admin. Supports django-parler and django-cms.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for metaforx from gravatar.com metaforx

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

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 beautiful Django Unfold admin interface (v.0.66.0) with additional functionality for:

  • django-cms: Integration with Django CMS 5.0 - Uses unfold admin colors for django cms
  • 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 automatically updaten from 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.

img.png img.png

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, but all features should work, beside filer.

Installation

  1. Install the package via pip:

    pip install django-unfold-extra

  2. Add to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
   # Unfold theme
   'unfold',
   'unfold_extra',
   'unfold_extra.contrib.cms',  # if extra packages
   'unfold_extra.contrib.parler',
   'unfold_extra.contrib.auth'  # you likely want to use your own implementation
   'unfold_extra.contrib.sites'

   # Your apps
   # ...
]

Make sure you've set up Django Unfold according to its documentation. https://github.com/unfoldadmin/django-unfold

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 3rd party packages
    ],
    "SCRIPTS": [
        lambda request: static("unfold_extra/js/theme-sync.js"), # switch django cms theme from "Unfold Admin"
    ],
}
CMS_COLOR_SCHEME_TOGGLE = False # disable django cms theme switch -> use Unfold admin theme switch or disable Unfold theme switch via styles, no config option yet.

Add {% unfold_extra_styles %} and {% unfold_extra_theme_receiver %} from unfold_extra_tags to your base HTML template.

  • Enables unfold admin colors in django cms
  • theme switch from unfold admin to change theme in djangs 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
  • Versioning
  • 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 to after loading all CSS styles. This adds additional styles to integrate django CMS with Unfold Admin and includes "COLORS" from unfold settings to 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 (see src/package.json)

{
	"name": "django-unfold-extra",
	"description": "Enhancing Django Unfold to support additional packages",
	"scripts": {
		"update:unfold-deps": "curl -s https://raw.githubusercontent.com/unfoldadmin/django-unfold/main/package.json | jq -r '[\"tailwindcss@\" + .dependencies.tailwindcss, \"@tailwindcss/typography@\" + .devDependencies[\"@tailwindcss/typography\"]] | join(\" \")' | xargs npm install --save-dev",
		"update:unfold-css": "curl -o css/styles.css https://raw.githubusercontent.com/unfoldadmin/django-unfold/main/src/unfold/styles.css",
		"update:unfold": "npm run update:unfold-deps && npm run update:unfold-css",
		"tailwind:build": "npx @tailwindcss/cli -i css/unfold_extra.css -o ../static/unfold_extra/css/styles.css --minify",
		"tailwind:watch": "npx @tailwindcss/cli -i css/unfold_extra.css -o ../static/unfold_extra/css/styles.css --watch --minify"
	},
	"devDependencies": {
		"@tailwindcss/cli": "^4.1.7",
		"@tailwindcss/typography": "^0.5.19",
		"tailwindcss": "^4.1.13"
	}
}

Change colors for Django CMS

You can change the colors for django CMS by editing css/unfold_extra.css or just update the unfold colors via settings.py.

  1. Fetch the latest Unfold version using update:unfold-deps and update:unfold-css
  2. Update config update:unfold
  3. Add changes tailwind:watch and `tailwind:build
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

  • Add Unfolds standard settings to django.contrib.auth,django.contrib.sites.

This is for personal use. You likely want to customize this.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for metaforx from gravatar.com metaforx

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

0.2.1

0.2.0

0.1.14

0.1.13

0.1.13b4 pre-release

0.1.13b3 pre-release

0.1.13b2 pre-release

0.1.13b1 pre-release

0.1.13b0 pre-release

0.1.12

0.1.11

0.1.10a0 pre-release

0.1.9

0.1.8

0.1.7

This version

0.1.7b0 pre-release

0.1.7a0 pre-release

0.1.6

0.1.5

0.1.4

0.1.3a0 pre-release

0.1.2

0.1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_unfold_extra-0.1.7b0.tar.gz (311.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_unfold_extra-0.1.7b0-py3-none-any.whl (324.3 kB view details)

Uploaded Python 3

File details

Details for the file django_unfold_extra-0.1.7b0.tar.gz.

File metadata

  • Download URL: django_unfold_extra-0.1.7b0.tar.gz
  • Upload date:
  • Size: 311.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for django_unfold_extra-0.1.7b0.tar.gz
Algorithm Hash digest
SHA256 f752c0d081e299528743f9e85d2830933d42da2a9f9d310ab65b2f88f726c9ae
MD5 0a166eec81d9f63529342d477051e18d
BLAKE2b-256 76b8a7b61903a2e59f0ec24e8c9909f4a404d71f27538f79742110b52ea2a44a

See more details on using hashes here.

File details

Details for the file django_unfold_extra-0.1.7b0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_unfold_extra-0.1.7b0-py3-none-any.whl
Algorithm Hash digest
SHA256 834c13add54d9c1a926705e573fbe375b5d93d716d5dbeac8ab76ae2d266c40b
MD5 62e4dfd0f40a1386f05f6e9f574084d4
BLAKE2b-256 6d4947da3f0139f27312c0fa39408dced9248f2feb477261796a6ebb3175ac79

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page