draftail-text-utils 0.1.7__py3-none-any.whl

draftail_text_utils/wagtail_hooks.py

@@ -0,0 +1,266 @@
+"""
+Wagtail hooks for draftail_text_utils.
+
+Integrates all rich-text feature registrations and injects the
+necessary CSS / JS assets into the Wagtail admin.
+"""
+
+import json
+
+from urllib.parse import urljoin
+
+from django.core.serializers.json import DjangoJSONEncoder
+from django.templatetags.static import static
+from django.utils.html import format_html, mark_safe
+from wagtail import hooks
+
+from draftail_text_utils.conf import (
+    feature_enabled,
+    get_font_sizes,
+    load_color_palette,
+    load_font_families,
+    load_font_urls,
+)
+from draftail_text_utils.rich_text import (
+    font_family,
+    font_size,
+    highlight_color,
+    text_alignment,
+    text_color,
+)
+
+
+@hooks.register("register_icons")
+def register_icons(icons):
+    return icons + [
+        "draftail_text_utils/icons/align-center.svg",
+        "draftail_text_utils/icons/align-justify.svg",
+        "draftail_text_utils/icons/align-left.svg",
+        "draftail_text_utils/icons/align-right.svg",
+        "draftail_text_utils/icons/font.svg",
+        "draftail_text_utils/icons/highlighter.svg",
+        "draftail_text_utils/icons/palette.svg",
+        "draftail_text_utils/icons/text-height.svg",
+    ]
+
+
+# ---------------------------------------------------------------------------
+# Feature registration
+# ---------------------------------------------------------------------------
+
+
+@hooks.register("register_rich_text_features")
+def register_text_alignment_feature(features):
+    text_alignment.register(features)
+
+
+@hooks.register("register_rich_text_features")
+def register_text_color(features):
+    text_color.register(features)
+
+
+@hooks.register("register_rich_text_features")
+def register_highlight_color(features):
+    highlight_color.register(features)
+
+
+@hooks.register("register_rich_text_features")
+def register_font_family_feature(features):
+    font_family.register(features)
+
+
+@hooks.register("register_rich_text_features")
+def register_font_size_feature(features):
+    font_size.register(features)
+
+
+# ---------------------------------------------------------------------------
+# Asset injection
+# ---------------------------------------------------------------------------
+
+
+def _feature_static(path):
+    return static(f"draftail_text_utils/{path}")
+
+
+@hooks.register("insert_global_admin_css")
+def global_admin_css():
+    links = set()
+    preconnect_links = set()
+
+    css_map = {
+        "TEXT_COLOR": "css/text_color.css",
+        "HIGHLIGHT_COLOR": "css/highlight_color.css",
+        "FONT_FAMILY": "css/font_family.css",
+        "FONT_SIZE": "css/font_size.css",
+        "TEXT_ALIGNMENT": "css/text_alignment.css",
+    }
+
+    for feature_name, css_path in css_map.items():
+        if feature_enabled(feature_name):
+            links.add(f'<link rel="stylesheet" href="{_feature_static(css_path)}">')
+
+    # Load font stylesheets
+    for url in load_font_urls():
+        if url:
+            preconnect_links.add(f'<link rel="preconnect" href="{urljoin(url, "/")}">')
+            links.add(f'<link rel="stylesheet" href="{url}">')
+
+    return mark_safe("\n".join(links.union(preconnect_links)))  # noqa: S308
+
+
+@hooks.register("insert_global_admin_js")
+def global_admin_js():
+    """
+    Injects JS assets for draftail_text_utils rich-text
+    features into the Wagtail admin
+    """
+    scripts = [
+        format_html(
+            "<script type='text/javascript'>{}</script>",
+            mark_safe("window.draftailTextUtils = window.draftailTextUtils || {};"),
+        ),
+    ]
+
+    if feature_enabled("TEXT_COLOR") or feature_enabled("HIGHLIGHT_COLOR"):
+        colors = load_color_palette()
+        scripts.append(
+            format_html(
+                "<script type='module'>{}</script>",
+                mark_safe(
+                    "import 'https://cdn.jsdelivr.net/gh/argyleink/css-color-component/dist/index.js';"
+                ),
+            )
+        )
+        scripts.append(_color_script(colors))
+
+        if feature_enabled("TEXT_COLOR"):
+            scripts.append(text_color.control())
+
+        if feature_enabled("HIGHLIGHT_COLOR"):
+            scripts.append(highlight_color.control())
+
+    if feature_enabled("FONT_FAMILY"):
+        families = load_font_families()
+        scripts.append(_font_family_script(families))
+        scripts.append(font_family.control())
+
+    if feature_enabled("FONT_SIZE"):
+        sizes = get_font_sizes()
+        scripts.append(_font_size_script(sizes))
+        scripts.append(font_size.control())
+
+    if feature_enabled("TEXT_ALIGNMENT"):
+        scripts.append(text_alignment.control())
+
+    return mark_safe("\n".join(scripts))  # noqa: S308
+
+
+# ---------------------------------------------------------------------------
+# Inline data injection helpers
+# ---------------------------------------------------------------------------
+
+
+def _color_script(colors):
+    text_colors = [
+        {
+            "type": f"TEXT_COLOR_{c['key'].upper()}",
+            "label": c["label"],
+            "value": c["value"],
+            "key": c["key"],
+            "style": {"color": c["value"]},
+        }
+        for c in colors
+    ]
+    highlight_colors = [
+        {
+            "type": f"HIGHLIGHT_COLOR_{c['key'].upper()}",
+            "label": c["label"],
+            "value": c["value"],
+            "key": c["key"],
+            "style": {"backgroundColor": c["value"]},
+        }
+        for c in colors
+    ]
+    text_color_style_map = {
+        f"TEXT_COLOR_{c['key'].upper()}": {"color": c["value"]} for c in colors
+    }
+    highlight_color_style_map = {
+        f"HIGHLIGHT_COLOR_{c['key'].upper()}": {"backgroundColor": c["value"]}
+        for c in colors
+    }
+
+    data = {
+        "customTextColors": text_colors,
+        "customHighlightColors": highlight_colors,
+        "customTextColorStyleMap": text_color_style_map,
+        "customHighlightColorStyleMap": highlight_color_style_map,
+    }
+    json_str = json.dumps(data, cls=DjangoJSONEncoder)
+    return format_html(
+        "<script type='text/javascript'>{}</script>",
+        mark_safe(  # noqa: S308
+            f"Object.assign(window.draftailTextUtils, {json_str});"
+        ),
+    )
+
+
+def _font_family_script(families):
+    data = {
+        "customFontFamilies": [
+            {
+                "label": f["label"],
+                "value": f["value"],
+                "type": f.get(
+                    "type", f"FONT_FAMILY_{f['label'].upper().replace(' ', '_')}"
+                ),
+                "style": {"fontFamily": f["value"]},
+            }
+            for f in families
+        ]
+    }
+    json_str = json.dumps(data, cls=DjangoJSONEncoder)
+    return format_html(
+        "<script type='text/javascript'>{}</script>",
+        mark_safe(  # noqa: S308
+            f"Object.assign(window.draftailTextUtils, {json_str});"
+        ),
+    )
+
+
+def _font_size_script(sizes):
+    data = {"customFontSizes": sizes}
+    json_str = json.dumps(data, cls=DjangoJSONEncoder)
+    return format_html(
+        "<script type='text/javascript'>{}</script>",
+        mark_safe(  # noqa: S308
+            f"Object.assign(window.draftailTextUtils, {json_str});"
+        ),
+    )
+
+
+# Keep original admin URL registration from the template
+
+
+@hooks.register("register_admin_urls")
+def register_admin_urls():
+    from django.urls import include, path
+    from django.views.i18n import JavaScriptCatalog
+
+    urls = [
+        path(
+            "jsi18n/",
+            JavaScriptCatalog.as_view(packages=["draftail_text_utils"]),
+            name="javascript_catalog",
+        ),
+    ]
+
+    return [
+        path(
+            "draftail_text_utils/",
+            include(
+                (urls, "draftail_text_utils"),
+                namespace="draftail_text_utils",
+            ),
+        )
+    ]

draftail_text_utils-0.1.7.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: draftail-text-utils
+Version: 0.1.7
+Summary: Extends Draftail's text customization
+Keywords: wagtail,draftail,rich text,text color,highlight,font size,font family,text alignment
+Author: baldwinboy
+License-Expression: BSD-3-Clause
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Wagtail
+Classifier: Framework :: Wagtail :: 6
+Classifier: Framework :: Wagtail :: 7
+Requires-Dist: cssutils>=2.15.0
+Requires-Dist: django>=5.0
+Requires-Dist: wagtail>=6.0
+Requires-Dist: wagtail-traverse>=1.0.1
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/baldwinboy/draftail-text-utils
+Project-URL: Repository, https://github.com/baldwinboy/draftail-text-utils
+Project-URL: Changelog, https://github.com/baldwinboy/draftail-text-utils/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/baldwinboy/draftail-text-utils/tree/main/docs
+Project-URL: Issues, https://github.com/baldwinboy/draftail-text-utils/issues
+Description-Content-Type: text/markdown
+
+# Draftail Text Utils
+
+Extends Draftail's text customization. Includes:
+- Text Color (with optional palettes)
+- Highlight Color
+- Font Family
+- Font Size
+- Text Alignment
+
+## Links
+
+- [Documentation](https://github.com/baldwinboy/draftail-text-utils/blob/main/README.md)
+- [Changelog](https://github.com/baldwinboy/draftail-text-utils/blob/main/CHANGELOG.md)
+- [Contributing](https://github.com/baldwinboy/draftail-text-utils/blob/main/CONTRIBUTING.md)
+- [Discussions](https://github.com/baldwinboy/draftail-text-utils/discussions)
+- [Security](https://github.com/baldwinboy/draftail-text-utils/security)
+
+## Supported versions
+
+This package supports Wagtail 7.0 and up, and all [compatible versions of Python and Django](https://docs.wagtail.org/en/stable/releases/upgrading.html#compatible-django-python-versions).
+
+## Installation
+
+Pick the command for your preferred package installer:
+
+```bash
+uv add draftail-text-utils
+poetry add draftail-text-utils
+pip install draftail-text-utils
+```

draftail_text_utils-0.1.7.dist-info/RECORD

@@ -0,0 +1,39 @@
+draftail_text_utils/__init__.py,sha256=C5mTSbp9UtWw-Ob2qELjYnL7Pxy2TF0HU_P77hERi6I,138
+draftail_text_utils/apps.py,sha256=hqB4f_S5EtGnNqzHax0buabxzhOKrAKdOsk0nOigBqU,189
+draftail_text_utils/conf.py,sha256=eiutiNC4x9vtti6cTck5FNPmn8eBmWaNKCrnEyVyi_A,14837
+draftail_text_utils/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+draftail_text_utils/rich_text/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+draftail_text_utils/rich_text/base.py,sha256=g-sBgA4IyjcrASavnaRsNT7qoRkxr9vU6Egq87YQmzY,7658
+draftail_text_utils/rich_text/font_family.py,sha256=6V1sb4yEwrBFaglqu8kKM7fnzNgwnPBNMKJ1HQGN9_Y,1463
+draftail_text_utils/rich_text/font_size.py,sha256=SmIkA42lyGY3tSOwcx-tq9IyYPH-7KV8gafBcWiqTy0,2441
+draftail_text_utils/rich_text/highlight_color.py,sha256=7rf9mAhxxmrLv7bouOfG-CzZ-b6eQqv1gmtXQrU7KEU,2717
+draftail_text_utils/rich_text/text_alignment.py,sha256=yYhRp7pecbYRDh2rbleJikn1gHAx9m-Q0t8jYiEzwP8,1838
+draftail_text_utils/rich_text/text_color.py,sha256=wLx0zvm0vTmgSFnZLHgfV9vwTeLG-rD9fi2c4wDdHzY,2412
+draftail_text_utils/static/draftail_text_utils/css/draftail_text_utils.css,sha256=-Jvc-XHXsLBUzPLjilhCSjmP1D9ppL7Bd0Xf09sGe7A,205
+draftail_text_utils/static/draftail_text_utils/css/font_family.css,sha256=YvGKHrM8L7jePE5O9s92KDXVPvlgh4Zg0KQBIA0IRYs,1412
+draftail_text_utils/static/draftail_text_utils/css/font_size.css,sha256=AzW9VFUth8uVfm30BAeWITVrrOpj66OMpG3yuskNbBw,2277
+draftail_text_utils/static/draftail_text_utils/css/highlight_color.css,sha256=nQ8BKwk-EZ0vskNSgc7iANgRV5x0ko851Hu57YFMf0M,2861
+draftail_text_utils/static/draftail_text_utils/css/text_alignment.css,sha256=9OHixNAxg23yFpUzU0LNZoDrxzkfKn0oFlqqwnyVJpI,1645
+draftail_text_utils/static/draftail_text_utils/css/text_color.css,sha256=RbyoMYANvyoxR6rIFmACmSLdeAHpFN01lwlzceXubFw,2791
+draftail_text_utils/static/draftail_text_utils/js/font_family.js,sha256=eE2wbud9O51U-4_Y6K_q_8G39wWXz4Uhw98sSTveSPU,4326
+draftail_text_utils/static/draftail_text_utils/js/font_size.js,sha256=Z5QERAH80AvkErW5nQ8SJmgde1TLZmJlP_1R7LTjn-Q,11444
+draftail_text_utils/static/draftail_text_utils/js/font_size_entity.js,sha256=xx1T1Ml6_9_FHoynwwQZKZFxQN4oWfSLJsDunTjN7RI,1016
+draftail_text_utils/static/draftail_text_utils/js/highlight_color.js,sha256=KwOsq7RXh-4cOX7BmWRg2lOpWXl856Wh0J26rxE2J24,10557
+draftail_text_utils/static/draftail_text_utils/js/highlight_color_entity.js,sha256=0VLsyVOmJyCLh8Gm9luy57bgNl_Ho19AUn-IHHMQt5s,1238
+draftail_text_utils/static/draftail_text_utils/js/text_alignment.js,sha256=fKLgJ3ubyumvlVkBMxBMc5SEpL3GswTFgQLNLLRdf_s,4077
+draftail_text_utils/static/draftail_text_utils/js/text_color.js,sha256=F0m80Bg0PC1JE3_rcffi1WQs7IU_5kYVw11sVM6GijA,10212
+draftail_text_utils/static/draftail_text_utils/js/text_color_entity.js,sha256=XfY0EyI9bfhcNXBGIMwL8EcuyAAzmCbVog_-yHzYK3M,1147
+draftail_text_utils/templates/draftail_text_utils/icons/align-center.svg,sha256=gm7rWinhbV6iJgWMWtz-kPlelM2Fbmc4yQFKmYNnUxE,653
+draftail_text_utils/templates/draftail_text_utils/icons/align-justify.svg,sha256=hdzEcC4pDVmWkp9yfhy9woS4UObQmZNV2RNP5rvFWnU,650
+draftail_text_utils/templates/draftail_text_utils/icons/align-left.svg,sha256=Fah5OQ_cbPLUqvQ8VMw7mkC1K3d6RUrBBSIsiFyPLIk,647
+draftail_text_utils/templates/draftail_text_utils/icons/align-right.svg,sha256=2RUZCk7FG6yxIG99xxdaIuO_t_qLe73A-at4987ssII,651
+draftail_text_utils/templates/draftail_text_utils/icons/font.svg,sha256=gKw_zMN9Ln0kvLn5OCwpRM_VQCuSbdrFdXi-WXMhglI,563
+draftail_text_utils/templates/draftail_text_utils/icons/highlighter.svg,sha256=7YXvEXy-3BHbbPV1ZybXClR7r2QB1DQZdIr7Z8dF2Es,709
+draftail_text_utils/templates/draftail_text_utils/icons/palette.svg,sha256=CwwKj-h1dXCpnIF8mKseTU-5W7Ed7HC91-1t2dHzya0,678
+draftail_text_utils/templates/draftail_text_utils/icons/text-height.svg,sha256=-x2wxFzdPkP5YAnrQ8zZeA3o04L-w71HOkOaN_ow2c4,830
+draftail_text_utils/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+draftail_text_utils/templatetags/draftail_text_utils_tags.py,sha256=q4liXr4q4IKQ6FLueB7IuhKi61Xvw_1pY2-N0BHxS6g,799
+draftail_text_utils/wagtail_hooks.py,sha256=mwYOkU5QwOScBrdEDq0JHTehoXrcUvAnYk39eVZYROU,7719
+draftail_text_utils-0.1.7.dist-info/WHEEL,sha256=f5fWSvWsg5Knq5GWa6t1nJIug0Tqo69GqAWD_9LbBKw,81
+draftail_text_utils-0.1.7.dist-info/METADATA,sha256=VWckHk0Q1kTpfs-9KJB64iDMGSU9ayCvQFrVh2Y4WUA,2443
+draftail_text_utils-0.1.7.dist-info/RECORD,,

draftail_text_utils-0.1.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.16
+Root-Is-Purelib: true
+Tag: py3-none-any