richie 2.32.0__py2.py3-none-any.whl → 2.32.1.dev1__py2.py3-none-any.whl

frontend/scss/colors/_theme.scss

@@ -151,6 +151,12 @@ $r-theme: (
     primary-color: r-color('denim'),
     secondary-color: r-color('white'),
   ),
+  slider-plugin: (
+    arrows-color: r-color('white'),
+    arrows-hover-color: r-color('firebrick6'),
+    index-color: r-color('charcoal'),
+    index-hover-color: r-color('black'),
+  ),
   blogpost-glimpse: (
     card-background: r-color('white'),
     title-color: r-color('black'),

frontend/scss/components/_index.scss

@@ -60,6 +60,7 @@
 @import './templates/courses/plugins/category_plugin';
 @import './templates/courses/plugins/licence_plugin';
 @import './templates/richie/simpletext/simpletext';
+@import './templates/richie/slider/slider';
 @import './templates/richie/section/section';
 @import './templates/richie/large_banner/large_banner';
 @import './templates/richie/large_banner/compacted_banner';

frontend/scss/components/templates/richie/slider/_slider.scss

@@ -0,0 +1,142 @@
+$r-slider-title-fontsize: $h1-font-size !default;
+$r-slider-title-fontweight: $font-weight-bold !default;
+$r-slider-title-fontfamily: $headings-font-family !default;
+$r-slider-content-fontsize: $h4-font-size !default;
+$r-slider-content-line-height: 1.1 !default;
+
+.slider {
+  position: relative;
+  width: 100%;
+  // Reserved space for slide indexes
+  padding-bottom: 1.75rem;
+
+  &__items {
+    display: flex;
+    overflow-x: hidden;
+  }
+
+  &__tools {
+    @include make-container-max-widths();
+    margin: 0 auto;
+    padding: 0;
+    display: flex;
+    justify-content: center;
+    align-content: center;
+  }
+
+  &__next,
+  &__previous {
+    position: absolute;
+    top: 25%;
+    left: 0;
+    right: 0;
+    background: none;
+    border: 0;
+
+    svg {
+      width: 5rem;
+      height: 5rem;
+      color: r-theme-val(slider-plugin, arrows-color);
+    }
+
+    &:hover {
+      svg {
+        color: r-theme-val(slider-plugin, arrows-hover-color);
+      }
+    }
+  }
+
+  &__next {
+    left: auto;
+    right: 0;
+  }
+
+  &__previous {
+    left: 0;
+    right: auto;
+  }
+
+  &__indexes {
+    @include make-container-max-widths();
+    margin: 0 auto;
+    width: 100%;
+    padding: 0.5rem;
+    position: absolute;
+    bottom: 0;
+    display: flex;
+    justify-content: flex-end;
+    align-items: center;
+  }
+
+  &__index {
+    @include sv-flex(1, 0, 1.9rem);
+    padding: 0;
+    height: 1rem;
+    background: transparent;
+    border: 0;
+
+    &::before {
+      content: '';
+      display: block;
+      height: 0.2rem;
+      background: r-theme-val(slider-plugin, index-color);
+      border: 0;
+    }
+
+    &--active {
+      pointer-events: none;
+
+      &::before {
+        height: 0.5rem;
+      }
+    }
+
+    &:hover {
+      &::before {
+        background: r-theme-val(slider-plugin, index-hover-color);
+      }
+    }
+  }
+
+  &__index + &__index {
+    margin-left: 0.3rem;
+  }
+}
+
+.slider-item {
+  @include sv-flex(1, 0, 100%);
+  display: block;
+  color: inherit;
+  text-decoration: none;
+
+  // Disable any hover event on content since it can be in a link
+  &:hover,
+  *:hover {
+    color: inherit !important;
+    text-decoration: none !important;
+  }
+
+  &__image {
+    display: block;
+    margin: 0 0 1rem 0;
+    width: 100%;
+  }
+
+  &__container {
+    @include make-container-max-widths();
+    position: relative;
+    margin: 0 auto;
+  }
+
+  &__title {
+    @include font-size($r-slider-title-fontsize);
+    font-family: $r-slider-title-fontfamily;
+    font-weight: $r-slider-title-fontweight;
+    margin: 0 0 0.5rem 0;
+  }
+
+  &__content {
+    @include font-size($r-slider-content-fontsize);
+    line-height: $r-slider-content-line-height;
+  }
+}

frontend/scss/settings/_variables.scss

@@ -182,3 +182,6 @@ $r-section-grid-gutters: (
   'sm': 0.5rem,
   'xl': 1rem,
 );
+
+// Slider plugin adjustments
+$r-slider-title-fontweight: $font-weight-extrabold;

richie/apps/courses/settings/__init__.py

@@ -114,7 +114,7 @@ CMS_PLACEHOLDER_CONF = {
     # Homepage
     "richie/homepage.html maincontent": {
         "name": _("Main content"),
-        "plugins": ["LargeBannerPlugin", "SectionPlugin"],
+        "plugins": ["LargeBannerPlugin", "SectionPlugin", "SliderPlugin"],
         "child_classes": {
             "SectionPlugin": [
                 "BlogPostPlugin",

richie/plugins/slider/cms_plugins.py

@@ -0,0 +1,85 @@
+"""
+Slider CMS plugins
+"""
+
+from django.utils.translation import gettext_lazy as _
+
+from cms.plugin_base import CMSPluginBase
+from cms.plugin_pool import plugin_pool
+
+from richie.apps.core.defaults import PLUGINS_GROUP
+
+from .forms import SlideItemForm, SliderForm
+from .models import SlideItem, Slider
+
+
+@plugin_pool.register_plugin
+class SliderPlugin(CMSPluginBase):
+    """
+    CMSPlugin to hold Slide plugin items.
+    """
+
+    cache = True
+    module = PLUGINS_GROUP
+    name = _("Slider")
+    model = Slider
+    form = SliderForm
+    render_template = "richie/slider/slider.html"
+    allow_children = True
+    child_classes = ["SlideItemPlugin"]
+    fieldsets = ((None, {"fields": ["title"]}),)
+
+    def render(self, context, instance, placeholder):
+        context.update(
+            {
+                "instance": instance,
+                "placeholder": placeholder,
+            }
+        )
+        return context
+
+
+@plugin_pool.register_plugin
+class SlideItemPlugin(CMSPluginBase):
+    """
+    CMSPlugin for slide item content.
+    """
+
+    cache = True
+    module = PLUGINS_GROUP
+    name = _("Slide item")
+    model = SlideItem
+    form = SlideItemForm
+    render_template = "richie/slider/slide-item.html"
+    require_parent = True
+    parent_classes = ["SliderPlugin"]
+    fieldsets = [
+        (
+            None,
+            {
+                "fields": (
+                    "title",
+                    "image",
+                    "content",
+                ),
+            },
+        ),
+        (
+            _("Link"),
+            {
+                "fields": (
+                    "link_url",
+                    "link_open_blank",
+                ),
+            },
+        ),
+    ]
+
+    def render(self, context, instance, placeholder):
+        context.update(
+            {
+                "instance": instance,
+                "placeholder": placeholder,
+            }
+        )
+        return context

richie/plugins/slider/factories.py

@@ -0,0 +1,33 @@
+"""
+Slider CMS plugin factories
+"""
+
+import factory
+
+from .models import SlideItem, Slider
+
+
+class SliderFactory(factory.django.DjangoModelFactory):
+    """
+    Factory to create instance of a Slider.
+    """
+
+    title = factory.Faker("text", max_nb_chars=20)
+
+    class Meta:
+        model = Slider
+
+
+class SlideItemFactory(factory.django.DjangoModelFactory):
+    """
+    Factory to create instance of a SlideItem.
+    """
+
+    title = factory.Faker("text", max_nb_chars=20)
+    content = factory.Faker("text", max_nb_chars=42)
+    image = factory.SubFactory("richie.apps.core.factories.FilerImageFactory")
+    link_url = factory.Faker("url")
+    link_open_blank = factory.Faker("pybool")
+
+    class Meta:
+        model = SlideItem

richie/plugins/slider/forms.py

@@ -0,0 +1,40 @@
+"""
+Slider plugin forms
+"""
+
+from django import forms
+
+from djangocms_text_ckeditor.widgets import TextEditorWidget
+
+from .models import SlideItem, Slider
+
+
+class SliderForm(forms.ModelForm):
+    """
+    Slider form used to fill its content from frontend admin.
+    """
+
+    class Meta:
+        model = Slider
+        fields = [
+            "title",
+        ]
+
+
+class SlideItemForm(forms.ModelForm):
+    """
+    SlideItem form used to fill its content from frontend admin.
+    """
+
+    class Meta:
+        model = SlideItem
+        fields = [
+            "title",
+            "image",
+            "content",
+            "link_url",
+            "link_open_blank",
+        ]
+        widgets = {
+            "content": TextEditorWidget,
+        }

richie/plugins/slider/migrations/0001_initial.py

@@ -0,0 +1,102 @@
+# Generated by Django 4.2.16 on 2024-11-22 00:16
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+import filer.fields.image
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        migrations.swappable_dependency(settings.FILER_IMAGE_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Slider",
+            fields=[
+                (
+                    "cmsplugin_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        related_name="%(app_label)s_%(class)s",
+                        serialize=False,
+                        to="cms.cmsplugin",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, verbose_name="title")),
+            ],
+            options={
+                "verbose_name": "Slider",
+                "verbose_name_plural": "Sliders",
+            },
+            bases=("cms.cmsplugin",),
+        ),
+        migrations.CreateModel(
+            name="SlideItem",
+            fields=[
+                (
+                    "cmsplugin_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        related_name="%(app_label)s_%(class)s",
+                        serialize=False,
+                        to="cms.cmsplugin",
+                    ),
+                ),
+                (
+                    "title",
+                    models.CharField(default="", max_length=150, verbose_name="title"),
+                ),
+                (
+                    "content",
+                    models.TextField(blank=True, default="", verbose_name="content"),
+                ),
+                (
+                    "link_url",
+                    models.URLField(
+                        blank=True,
+                        help_text="Make the slide as a link with an URL.",
+                        max_length=255,
+                        null=True,
+                        verbose_name="link URL",
+                    ),
+                ),
+                (
+                    "link_open_blank",
+                    models.BooleanField(
+                        default=False,
+                        help_text="If checked the link will be open in a new window",
+                        verbose_name="open new window",
+                    ),
+                ),
+                (
+                    "image",
+                    filer.fields.image.FilerImageField(
+                        default=None,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="slide_image",
+                        to=settings.FILER_IMAGE_MODEL,
+                        verbose_name="image",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Slide item",
+                "verbose_name_plural": "Slide items",
+            },
+            bases=("cms.cmsplugin",),
+        ),
+    ]

richie/plugins/slider/models.py

@@ -0,0 +1,111 @@
+"""
+Slider plugin models
+"""
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from cms.models.pluginmodel import CMSPlugin
+from filer.fields.image import FilerImageField
+
+
+class Slider(CMSPlugin):
+    """
+    Slide container plugin for Slide item plugins.
+    """
+
+    title = models.CharField(_("title"), max_length=255)
+
+    class Meta:
+        verbose_name = _("Slider")
+        verbose_name_plural = _("Sliders")
+
+    def __str__(self):
+        return self.title
+
+    @property
+    def front_identifier(self):
+        """
+        Return standardized identifier for the slider container.
+        """
+        return f"slider-{self.id}"
+
+    @property
+    def payload_identifier(self):
+        """
+        Return standardized identifier for the slider payload.
+        """
+        return f"{self.front_identifier}-data"
+
+    def get_slider_payload(self):
+        """
+        Serializer a slider object and its slide items to Python object.
+
+        Arguments:
+            instance (richie.plugins.slider.models.SlideItem): Instance of a Slider
+                object.
+
+        Returns:
+            dict: Dictionnary of slider data.
+        """
+
+        slides = self.child_plugin_instances or []
+
+        return {
+            "pk": self.id,
+            "title": self.title,
+            "slides": [
+                {
+                    "pk": plugin.id,
+                    "title": plugin.title,
+                    "image": plugin.image.url,
+                    "content": plugin.content,
+                    "link_url": plugin.link_url,
+                    "link_open_blank": plugin.link_open_blank,
+                }
+                for plugin in slides
+            ],
+        }
+
+
+class SlideItem(CMSPlugin):
+    """
+    Slide item plugin to include in a Slider plugin.
+    """
+
+    title = models.CharField(
+        _("title"),
+        max_length=150,
+        default="",
+    )
+    image = FilerImageField(
+        related_name="slide_image",
+        verbose_name=_("image"),
+        on_delete=models.SET_NULL,
+        null=True,
+        default=None,
+    )
+    content = models.TextField(
+        _("content"),
+        blank=True,
+        default="",
+    )
+    link_url = models.URLField(
+        verbose_name=_("link URL"),
+        blank=True,
+        null=True,
+        max_length=255,
+        help_text=_("Make the slide as a link with an URL."),
+    )
+    link_open_blank = models.BooleanField(
+        _("open new window"),
+        default=False,
+        help_text=_("If checked the link will be open in a new window"),
+    )
+
+    class Meta:
+        verbose_name = _("Slide item")
+        verbose_name_plural = _("Slide items")
+
+    def __str__(self):
+        return self.title

richie/plugins/slider/templates/richie/slider/slider.html

@@ -0,0 +1,4 @@
+{% load cms_tags i18n %}{% spaceless %}
+    <div id="{{ instance.front_identifier }}" class="slider" data-props-source="#{{ instance.payload_identifier }}"></div>
+    {{ instance.get_slider_payload|json_script:instance.payload_identifier }}
+{% endspaceless %}