django-component-tags 0.0.6.1
Create advanced HTML components using Django Tags.
License: MIT
Keywords: "django","component","tags","templatetags","template"

=======================
Django - Component Tags
=======================

:Test Status:
    .. image:: https://img.shields.io/github/workflow/status/syse-i/django-component-tags/Run%20tests
        :alt: GitHub Workflow Status

:Version Info:
    .. image:: https://img.shields.io/pypi/v/django-component-tags?label=PyPi
        :alt: PyPI

    .. image:: https://img.shields.io/pypi/dm/django-component-tags?label=Downloads&style=flat-square
        :alt: PyPI - Downloads

:Compatibility:
    .. image:: https://img.shields.io/pypi/pyversions/django-component-tags?style=flat-square&label=Python%20Versions
        :target: https://pypi.org/project/coveralls/

    .. image:: https://img.shields.io/pypi/djversions/django-component-tags?label=Django%20Versions&style=flat-square
        :alt: PyPI - Django Version

Create advanced HTML components using Django Tags.


Description
===========

Use `Django Template Tags <https://docs.djangoproject.com/en/3.1/ref/templates/builtins/>`_ and write
**reusable html components**.


Features
========

* Class based template tags.
* Template tag argument parser.
* Declarative component attributes.
* Extendable components.
* Embedded slot components.
* Media class (css/js) implementation (`Django Form-Media class <https://docs.djangoproject.com/en/3.1/topics/forms/media/>`_)

.. note::

    **django-component-tags** implements a simple content distribution API inspired by the
    `Web Components spec draft <https://github.com/WICG/webcomponents/blob/gh-pages/proposals/Slots-Proposal.md>`_,
    using the ``{% slot %}`` component inside another component to serve as distribution outlets for content.


Extra
=====

Libraries created with ``django-component-tags``:

* `django-component-tags-tailwindcss <https://github.com/syse-i/django-component-tags-tailwindcss>`_


Requirements
============

Requires Django 2.2 or newer, tested against Python 3.7 and PyPy.


Quick Start
===========

Install the library:

.. code-block::

    pip3 install django-component-tags

Update your ``settings.py``:

.. code-block::

    INSTALLED_APPS = [
        ...
        'component_tags',
        ...
    ]

    ...

    TEMPLATES = [
        {
            'OPTIONS': {
                'builtins': ['component_tags.template.builtins'], # slot component
            },
        },
    ]

    ...


Assuming that you already have an `application <https://docs.djangoproject.com/en/3.1/intro/tutorial01/>`_
called **foo**, lets create a new component tag:

.. code-block:: python

    # foo/templatetags/foo_tags.py
    from component_tags import template

    register = template.Library()

    @register.tag
    class Link(template.Component):
        href = template.Attribute(default='#')

        class Meta:
            template_name = 'tags/link.html'


.. note::

    **django-component-tags** extends the default django template library, because it wraps component classes with a parser
    function and extracts template tag arguments, everything else is left in the same way.

    Please check out `the template library <https://github.com/syse-i/django-component-tags/blob/main/src/component_tags/template/library.py>`_
    if you want to know more about this process.

Next, creating the component template:

.. code-block::

    # foo/templates/foo/tags/link.html

    <a {{ attributes }}>
        {{ nodelist }}
    </a>

Here we have a couple of variables inside a component template:

* **attributes**: component template/class attributes (formatted).
* **nodelist**: the content created between ``{% link %}`` and ``{% endlink %}`` will be rendered here.

Finally, you can use it as follows:

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}

    {% link %}
        Link 1
    {% endlink %}

Output:

.. code-block::

    # foo/templates/foo/index.html

    <a href="#">
        Link 1
    </a>

This is the simplest way to start, there is a lot of different settings that you can combine to create complex
html components.


Considerations
==============

Making multiple changes on html components and using cache interferes with the ``Media Class Library``,
which i believe its good on **production**. Django recommends to set up
`DummyCache <https://docs.djangoproject.com/en/3.1/topics/cache/#dummy-caching-for-development>`_
on **development** environments:

.. code-block:: python

    CACHES = {
        'default': {
            'BACKEND': 'django.core.cache.backends.dummy.DummyCache',
        }
    }


Examples
========

Adding css/js scripts
---------------------

Assuming that you already downloaded a css framework in your project like `BootstrapCSS <https://getbootstrap.com>`_.

Lets create a component:

.. code-block:: python

    # foo/templatetags/foo_tags.py
    from component_tags import template

    register = template.Library()

    @register.tag
    class Link(template.Component):
        href = template.Attribute(default='#')

        class Meta:
            template_name = 'tags/link.html'
            css = {
                'all': ('css/bootstrap.min.css',)
            }
            js = [
                'js/bootstrap.bundle.min.js',
            ]


Rendering the component in the main template:

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}
    <!doctype html>
    <html lang="en">
    <head>
        <meta charset="utf-8">
        <title>---</title>
        <meta name="description" content="---">
        <meta name="author" content="---">
        {% components_css %}
    </head>

    <body>
    {% link %}
        Link 1
    {% endlink %}
    {% components_js %}
    </body>
    </html>

Output:

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}
    <!doctype html>
    <html lang="en">
    <head>
        <meta charset="utf-8">
        <title>---</title>
        <meta name="description" content="---">
        <meta name="author" content="---">
        <link href="/static/css/bootstrap.min.css" type="text/css" media="all" rel="stylesheet">
    </head>

    <body>
    <a class="btn btn-primary" href="#">
        Link 1
    </a>
    <script src="/static/js/bootstrap.bundle.min.js"></script>
    </body>
    </html>


Adding css classes
------------------

Lets create a html component using the `bootstrap framework <https://getbootstrap.com>`_

.. code-block:: python

    # foo/templatetags/foo_tags.py
    from component_tags import template

    register = template.Library()

    @register.tag
    class Link(template.Component):
        class ColorChoices(template.AttributeChoices):
            primary = 'btn btn-primary'
            secondary = 'btn btn-secondary'
            success = 'btn btn-success'
            danger = 'btn btn-danger'
            warning = 'btn btn-warning'
            info = 'btn btn-info'

        color = template.Attribute(choices=TypeChoices, default=TypeChoices.submit, as_class=True)
        href = template.Attribute(default='#')

        class Meta:
            template_name = 'tags/link.html'
            css = {
                'all': ('css/bootstrap.min.css',)
            }
            js = [
                'js/bootstrap.bundle.min.js',
            ]

Rendering the component:

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}
    <!doctype html>
    <html lang="en">
    <head>
        <meta charset="utf-8">
        <title>---</title>
        <meta name="description" content="---">
        <meta name="author" content="---">
        {% components_css %}
    </head>

    <body>
    {% link color="primary" class="foo-bar" %}
        Link 1
    {% endlink %}

    {% components_js %}
    </body>
    </html>

Also we added the ``class`` argument to the component tag, so even if the components strictly have class attributes,
you will always have a flexible way to customize your components any time in different scenarios.

Output:

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}
    <!doctype html>
    <html lang="en">
    <head>
        <meta charset="utf-8">
        <title>---</title>
        <meta name="description" content="---">
        <meta name="author" content="---">
        <link href="/static/css/bootstrap.min.css" type="text/css" media="all" rel="stylesheet">
    </head>

    <body>
    <a class="btn btn-primary foo-bar" href="#">
        Link 1
    </a>
    <script src="/static/js/bootstrap.bundle.min.js"></script>
    </body>
    </html>

Note that it was merged with all attribute classes previously declared.


Using slot components
---------------------

Lets make another html component using the `bootstrap framework <https://getbootstrap.com>`_,
this one is going to be a ``Card`` component.

.. code-block:: python

    # foo/templatetags/foo_tags.py
    from component_tags import template

    register = template.Library()

    @register.tag
    class Card(template.Component):
        title = template.Attribute(required=True, as_context=True)

        class Meta:
            template_name = 'tags/card.html'

Create the component template:

.. code-block::

    # foo/templates/foo/tags/card.html

    <div class="card" style="width: 18rem;">
      <img src="..." class="card-img-top" alt="...">
      <div class="card-body">
        <h5 class="card-title">{{ title }}</h5>
        <div class="card-text">
            {{ nodelist }}
        </div>
        {% if slot_footer %}
            <div class="card-footer">
                {{ slot_footer }}
            </div>
        {% endif %}
      </div>
    </div>

Rendering the component:

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}

    {% card title='foo' %}
        Some quick example text to build on the card title and make up the bulk of the card's content.
        {% slot 'footer' %}
            <a href="#" class="btn btn-primary">Go somewhere</a>
        {% endslot %}
    {% endcard %}

Output:

.. code-block::

    # foo/templates/foo/index.html

    <div class="card" style="width: 18rem;">
        <img src="..." class="card-img-top" alt="...">
        <div class="card-body">
            <h5 class="card-title">foo</h5>
            <div class="card-text">
                Some quick example text to build on the card title and make up the bulk of the card's content.
            </div>
            <div class="card-footer">
                <a href="#" class="btn btn-primary">Go somewhere</a>
            </div>
        </div>
    </div>


Adding extra context
--------------------

By default, all components used isolated context to work with. If you want to pass global context to the component tag
it is required to use the ``with`` argument.

.. code-block:: python

    # foo/views.py
    def foo(request, object_id=None):
        return render(request, 'foo/index.html', {
            'object_id': object_id
        })

.. code-block::

    # foo/templates/foo/index.html
    {% load foo_tags %}

    {% link color="primary" with id=object_id %}
        Link {{ id }}
    {% endlink %}

Assuming that the request of the page will be something like ``http://localhost:8000/foo/1/``, the output will be:

.. code-block::

    # foo/templates/foo/index.html

    <a class="btn btn-primary" href="#">
        Link 1
    </a>

.. note::

    ``Slot`` components doesn't need to specify global context, they always use the parent context as default.

.. _pyscaffold-notes:

Note
====

This project has been set up using PyScaffold 4.0rc2. For details and usage
information on PyScaffold see https://pyscaffold.org/.