django_slots

允许捕获多行字符串并将其传递到模板标签。

演示

1. 注册组件

# app/templatetags/component_tags.py
from django_slots import Library, Component

register = Library()


@register.block_component
class Details(Component):
  pass

2. 创建模板

{# app/templates/components/details.html #}
<details>
<summary>{{ summary|default:slots.summary }}</summary>
{{ slot }}
</details>

使用方法

{% load component_tags %}
{% load slot_tags %}

{% details summary="the summary" %}
  the default slot
{% /details %}

{% details %}
  {% slot summary %}the <b>summary</b>{% /slot %}
  the default slot
{% /details %}

安装

pip install django-slots

INSTALLED_APPS = [
    # ...
    
    'django_slots',
]

插槽

使用{% slot name %}{% /slot %}来捕获并命名一个插槽。这些插槽将作为名为slots的字典在模板中可用。例如{{ slots.name }}。

任何没有被插槽标签包围的行将作为{{ slot }}在组件模板中可用。

模板

默认的模板路径是components/<component_name>.html。

使用template_name属性或get_template_name()方法来覆盖。

更改名称

默认情况下，模板标签的名称将是Component类名称转换为蛇形。使用name属性来覆盖。

例如

from django_slots import Component, Library

register = Library()


@register.inline_component
class Button(Component):
    name = 'btn'

{% btn %}

更改名称格式

默认情况下，内联标签的名称是"{name}/"，块标签的名称是"{name}", "/{name}"。要更改此格式，请指定inline_tag_name和block_tag_names属性。

例如

from django_slots import Component, Library

register = Library()


class AppComponent(Component):
    inline_tag_name = "{name}end"
    block_tag_names = "{name}", "end{name}"    

    
@register.component
class Button(AppComponent):
    pass

{% buttonend %}

{% button %}{% endbutton %}

仅内联模板标签

使用@register.inline_component仅允许使用{% inline/ %}。

仅块模板标签

使用@register.block_component仅允许使用{% block %}{% /block %}。

验证参数

实现def get_content_data(slots, **kwargs)以验证参数。

例如

from django_slots import Component, Library

register = Library()


@register.component
class Button(Component):
    STYLE = ["primary", "secondary"]
    def get_context_data(self, slots, *, style: str):
        if style not in self.STYLE:
            raise self.validation_error(f"style {style!r} not in {self.STYLE!r}")
        return super().get_context_data(slots, style=style)

命名空间组件

组件可以进行命名空间划分，这对于创建第三方应用非常有用。

from django_slots import Library, Component

register = Library()


class NHSUKComponent(Component):
    namespace = 'nhsuk'


@register.component
class Button(NHSUKComponent):
    pass

{% nhsuk:button %}
  Save and continue
{% /nhsuk:button %}

请参阅 https://github.com/nwjlyons/nhsuk-components