wagtail-tw-blocks 0.1.0__py3-none-any.whl

wagtail_blocks/__init__.py

@@ -0,0 +1,54 @@
+"""Wagtail Blocks"""
+
+from django.utils.translation import gettext_lazy as _
+
+# Constants
+ACCORDION_STYLE_VARIANTS = [
+    ("plus", _("Plus")),
+    ("arrow", _("Arrow")),
+]
+
+ALERT_STYLE_VARIANTS = [
+    ("soft", _("Soft")),
+    ("outlined", _("Outlined")),
+    ("dashed", _("Dashed")),
+]
+
+ALERT_LEVELS = [
+    ("info", _("Info")),
+    ("success", _("Success")),
+    ("warning", _("Warning")),
+    ("error", _("Error")),
+]
+
+# The popular programming languages
+PROGRAMMING_LANGUAGES = [
+    ("auto", _("Auto")),
+    ("bash", "Bash"),
+    ("c", "C"),
+    ("cpp", "C++"),
+    ("csharp", "C#"),
+    ("css", "CSS"),
+    ("dart", "Dart"),
+    ("dockerfile", "Dockerfile"),
+    ("go", "Go"),
+    ("html", "HTML"),
+    ("java", "Java"),
+    ("javascript", "JavaScript"),
+    ("json", "JSON"),
+    ("kotlin", "Kotlin"),
+    ("lua", "Lua"),
+    ("markdown", "Markdown"),
+    ("php", "PHP"),
+    ("python", "Python"),
+    ("ruby", "Ruby"),
+    ("rust", "Rust"),
+    ("scss", "SCSS"),
+    ("shell", "Shell"),
+    ("sql", "SQL"),
+    ("swift", "Swift"),
+    ("typescript", "TypeScript"),
+    ("xml", "XML"),
+    ("yaml", "YAML"),
+    ("plaintext", _("Plain text")),
+]

wagtail_blocks/apps.py

@@ -0,0 +1,12 @@
+"""AppConf for wagtail_blocks"""
+
+from django.apps import AppConfig
+
+
+# Create your config here.
+class WagtailBlocksConfig(AppConfig):
+    """App configuration for wagtail_blocks"""
+
+    name = "wagtail_blocks"
+    label = "wagtail_tw_blocks"
+    default_auto_field = "django.db.models.BigAutoField"

wagtail_blocks/blocks.py

@@ -0,0 +1,224 @@
+"""Custom Wagtail CMS blocks"""
+
+from django.conf import settings
+from django.utils.translation import gettext_lazy as _
+from wagtail import blocks
+from wagtail.embeds.blocks import EmbedBlock
+from wagtail.images.blocks import ImageBlock
+
+from wagtail_blocks import (
+    ACCORDION_STYLE_VARIANTS,
+    ALERT_LEVELS,
+    ALERT_STYLE_VARIANTS,
+    PROGRAMMING_LANGUAGES,
+)
+
+
+# Settings
+PROGRAMMING_LANGUAGES = getattr(
+    settings,
+    "WAGTAIL_BLOCKS_PROGRAMMING_LANGUAGES",
+    PROGRAMMING_LANGUAGES,
+)
+
+SHOW_PROGRAMMING_LANGUAGE = getattr(
+    settings,
+    "WAGTAIL_BLOCKS_SHOW_PROGRAMMING_LANGUAGE",
+    True,
+)
+
+SHOW_COPY_BUTTON = getattr(
+    settings,
+    "WAGTAIL_BLOCKS_SHOW_COPY_BUTTON",
+    True,
+)
+
+
+class ButtonBlock(blocks.StructBlock):
+    """Action block (link)"""
+
+    label = blocks.CharBlock(
+        max_length=32,
+        required=False,
+        help_text=_("Action label"),
+    )
+    page = blocks.PageChooserBlock(
+        required=False,
+        help_text=_("Action internal link"),
+    )
+    url = blocks.URLBlock(
+        required=False,
+        help_text=_("Action external link"),
+    )
+
+
+class AccordionItemBlock(blocks.StructBlock):
+    """Accordion Item"""
+
+    is_expanded = blocks.BooleanBlock(
+        default=False,
+        required=False,
+        help_text=_("Wether to show or hide item content"),
+    )
+    title = blocks.CharBlock(
+        max_length=64,
+        required=True,
+        help_text=_("Item title"),
+    )
+    content = blocks.RichTextBlock(
+        required=True,
+        help_text=_("Item content"),
+    )
+
+
+class AccordionBlock(blocks.StructBlock):
+    """Accordions block"""
+
+    name = blocks.CharBlock(
+        max_length=64,
+        required=True,
+        help_text=_("Accordion name"),
+    )
+    variant = blocks.ChoiceBlock(
+        choices=ACCORDION_STYLE_VARIANTS,
+        required=False,
+        help_text=_("Style variant"),
+    )
+    items = blocks.ListBlock(
+        AccordionItemBlock(),
+        required=True,
+        help_text=_("Accordion items"),
+    )
+
+    class Meta:
+        """Meta data"""
+
+        icon = "folder-open-inverse"
+        template = "wagtail_blocks/blocks/accordion.html"
+
+
+class AlertBlock(blocks.StructBlock):
+    """Alert block"""
+
+    variant = blocks.ChoiceBlock(
+        choices=ALERT_STYLE_VARIANTS,
+        required=False,
+        help_text=_("Style variant"),
+    )
+    level = blocks.ChoiceBlock(
+        choices=ALERT_LEVELS,
+        required=False,
+        help_text=_("Alert level"),
+    )
+    message = blocks.RichTextBlock(
+        required=True,
+        help_text=_("Alert message"),
+        features=[
+            "bold",
+            "italic",
+            "link",
+            "document-link",
+            "code",
+            "superscript",
+            "subscript",
+            "strikethrough",
+        ],
+    )
+    actions = blocks.ListBlock(
+        ButtonBlock(
+            required=False,
+            help_text=_("Alert action"),
+        ),
+        required=False,
+        help_text=_("Alert actions"),
+    )
+
+    class Meta:
+        """Meta data"""
+
+        icon = "warning"
+        template = "wagtail_blocks/blocks/alert.html"
+
+
+class CarouselItemBlock(blocks.StructBlock):
+    """Carousel Item block"""
+
+    image = ImageBlock(
+        required=False,
+        help_text=_("Image"),
+    )
+    video = EmbedBlock(
+        required=False,
+        help_text=_("Video"),
+    )
+
+
+class CarouselBlock(blocks.StructBlock):
+    """Carousel block"""
+
+    is_vertical = blocks.BooleanBlock(
+        default=False,
+        required=False,
+        help_text=_("Designates if carousel is vertical or horizontal (default)"),
+    )
+    items = blocks.ListBlock(
+        CarouselItemBlock(),
+        required=True,
+        help_text=_("Carousel items"),
+    )
+
+    class Meta:
+        """Meta data"""
+
+        icon = "image"
+        template = "wagtail_blocks/blocks/carousel.html"
+
+
+class CodeBlock(blocks.StructBlock):
+    """Code block"""
+
+    show_language = blocks.BooleanBlock(
+        default=SHOW_PROGRAMMING_LANGUAGE,
+        required=False,
+        help_text=_("Wether to show or hide which programming language is used"),
+    )
+    show_copy_btn = blocks.BooleanBlock(
+        default=SHOW_COPY_BUTTON,
+        required=False,
+        help_text=_("Wether to show or hide copy buttons"),
+    )
+    language = blocks.ChoiceBlock(
+        choices=PROGRAMMING_LANGUAGES,
+        default="auto",
+        required=True,
+        help_text=_("Programming language"),
+    )
+    code = blocks.TextBlock(
+        required=True,
+        help_text=_("Code content"),
+    )
+
+    class Meta:
+        """Meta data"""
+
+        icon = "code"
+        template = "wagtail_blocks/blocks/code.html"
+
+
+class DiffBlock(blocks.StructBlock):
+    """Diff block"""
+
+    item_1 = ImageBlock(
+        required=True,
+        help_text=_("Diff Item 1"),
+    )
+    item_2 = ImageBlock(
+        required=True,
+        help_text=_("Diff Item 2"),
+    )
+
+    class Meta:
+        """Meta data"""
+
+        icon = "code"
+        template = "wagtail_blocks/blocks/diff.html"

wagtail_blocks/static/wagtail_blocks/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "tailwindStylesheet": "./css/app.css",
+  "plugins": ["prettier-plugin-tailwindcss"]
+}

wagtail_blocks/static/wagtail_blocks/README.md

@@ -0,0 +1,23 @@
+# UI Styles
+
+Basic commands to get started.
+
+First `cd` into dir:
+
+```console
+cd .\wagtail_blocks\static\wagtail_blocks\
+```
+
+To generate the styles:
+
+```console
+npm install
+cd .\wagtail_blocks\static\wagtail_blocks\
+npx @tailwindcss/cli -i ../static/wagtail_blocks/css/app.css -o ../static/wagtail_blocks/css/styles.css --cwd ../../templates -m -w
+```
+
+To format the templates:
+
+```console
+npx prettier -w ../../templates
+```

wagtail_blocks/static/wagtail_blocks/css/app.css

@@ -0,0 +1,6 @@
+@import "tailwindcss";
+@plugin "@tailwindcss/typography";
+
+@plugin "daisyui" {
+  themes: all;
+}