Django template styling for Girder-4 applications.
Project description
django-girder-style
django-girder-style is a Django library providing Django template styling for Girder-4 applications.
Benefits
django-girder-style provides an extensible block-oriented base HTML template. This base template includes a pre-built Tailwind CSS (with some minor customizations) stylesheet, Remix Icon support, and the Nunito font.
Additionally, django-girder-style provides styled versions of all django-allauth view templates. This styling allows some limited branding customization as well.
Installation
Install django-girder-style:
pip install django-girder-style
Enable django-girder-style as an installed Django app:
# settings.py
INSTALLED_APPS = [
# Any project-local apps should come before "girder_style",
# so templates can be overridden as needed
'my_django_app.apps.MyDjangoAppConfig',
...,
'girder_style',
...,
# If "allauth" is installed, it must come after "girder_style"
'allauth',
'allauth.account',
'allauth.socialaccount',
]
Usage
Base Template
All project templates
should extend
girder_style/base.html.
This provides the following blocks to inject content:
head_title: The content of the<title>tag.extra_head: Additional HTML placed within the<head>tag.body: The entire HTML body content, including the<body>tag itself.
For example, a template my_app/home.html may contain:
{% extends 'girder_style/base.html' %}
{% block head_title %}My App{% endblock %}
{% block extra_head %}
<script src="https://cdn.jsdelivr.net/npm/jquery@3.6.0/dist/jquery.min.js"></script>
{% endblock %}
{% block body %}
<body>
<div style="font-bold">Hello World.</div>
<i class="ri-hearts-fill"></i>
</body>
{% endblock %}
All basic Tailwind CSS classes are available for use in templates
extending girder_style/base.html, as illustrated in the example above.
No additional configuration of Tailwind CSS is required (or possible).
For a full list of the additional Tailwind CSS customizations applied by django-girder-style,
see the Tailwind CSS confile file and
the stylesheet.
The Remix Icon library is also available in the same way.
Icons are typically used by adding an <i class="ri-... element, but see
the Remix Icon documentation for full usage
information.
django-allauth Templates
When django-girder-style is properly installed with django-allauth, templates will automatically be overridden with styled alternatives.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-girder-style-0.4.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7a03034651d79deab772e1e72dbd1318ba198d5ed088f2059b26ed9c0d93c620 |
|
| MD5 | 742e0a8fbf98dec29d18674710853f13 |
|
| BLAKE2b-256 | 8166ae7da6f20318b4dab160b9f4731631d28998cf1f1a65fbe902c1d84dfd51 |
Hashes for django_girder_style-0.4.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a9ad0984842baff7c898a16c0d70e62d83403400b7388b7a89ee86b0ceecdd8f |
|
| MD5 | edce60ab32d6b23434e39d37b8c01ebc |
|
| BLAKE2b-256 | e5cebd291073d832a0dc1204469e52c61a97fb2b99c6d10f7e261ebefd7705bd |