Skip to main content

A way to create simple reusable template components in Django.

Project description

django-components

A way to create simple reusable template components in Django.

Compatiblity

Python version Django version
2.7 1.11
3.4 1.11, 2.0
3.5 1.11, 2.0, 2.1, 2.2
3.6 1.11, 2.0, 2.1, 2.2
3.7 1.11, 2.0, 2.1, 2.2
3.8 1.11, 2.0, 2.1, 2.2

Installation

Install the app into your environment:

pip install django_reusable_components

Then add the app into INSTALLED APPS in settings.py

INSTALLED_APPS = [
    ...,
    "django_components",
    ...
]

Optional

To avoid loading the app in each template using {% load django_components %}, you can add the tag as a 'builtin' in settings.py

TEMPLATES = [
    {
        ...,
        'OPTIONS': {
            'context_processors': [
                ...
            ],
            'builtins': [
                'django_components.templatetags.component_tags',
            ]
        },
    },
]

Create your first component

A component in django-components is the combination of four things: CSS, Javascript, a Django template, and some Python code to put them all together.

First you need a CSS file. Be sure to prefix all rules with a unique class so they don't clash with other rules.

/* In a file called style.css */
.calendar-component { width: 200px; background: pink; }
.calendar-component span { font-weight: bold; }

Then you need a javascript file that specifies how you interact with this component. You are free to use any javascript framework you want. A good way to make sure this component doesn't clash with other components is to define all code inside an anonymous function that calls itself. This makes all variables defined only be defined inside this component and not affect other components.

/* In a file called script.js */
(function(){
    $(".calendar-component").click(function(){ alert("Clicked calendar!"); })
})()

Now you need a Django template for your component. Feel free to define more variables like date in this example. When creating an instance of this component we will send in the values for these variables. The template will be rendered with whatever template backend you've specified in your Django settings file.

{# In a file called calendar.html #}
<div class="calendar-component">Today's date is <span>{{ date }}</span></div>

Finally, we use django-components to tie this together. We create a Component by inheriting from the Component class and specifying the context method. We also register the global component registry so that we easily can render it anywhere in our templates.

from django_components import component

class Calendar(component.Component):
    def context(self, date):
        return {
            "date": date,
        }

    def template(self, date):
        return "[your app]/components/calendar/calendar.html"

    class Media:
        css = {'all': ['[your app]/components/calendar/calendar.css']}
        js = ['[your app]/components/calendar/calendar.js']

component.registry.register(name="calendar", component=Calendar)

And voilá! We've created our first component.

Use the component in a template

First load the django_components tag library, then use the component_dependencies and component tags to render the component to the page.

{% load django_components %}
<!DOCTYPE html>
<html>
<head>
    <title>My example calendar</title>
    {% component_dependencies %}
</head>
<body>
    {% component name="calendar" date="2015-06-19" %}
</body>
<html>

The output from the above template will be:

<!DOCTYPE html>
<html>
<head>
    <title>My example calendar</title>
    <link href="style.css" type="text/css" media="all" rel="stylesheet">
    <script type="text/javascript" src="script.js"></script>
</head>
<body>
    <div class="calendar-component">Today's date is <span>2015-06-19</span></div>
</body>
<html>

This makes it possible to organize your front-end around reusable components. Instead of relying on template tags and keeping your CSS and Javascript in the static directory.

Running the tests

To quickly run the tests install the local dependencies by running

pip install -r requirements-dev.txt
./pytest

The library is also tested across many versions of Python and Django. To run tests that way:

pip install -r requirements-dev.txt
tox

Project details


Release history Release notifications

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-reusable-components, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size django_reusable_components-0.1-py3-none-any.whl (5.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django_reusable_components-0.1.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page