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.head_extra: 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 head_extra %}
<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.5.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2bb7661903f2cdab3133adbc9034c3bd122ca59c17dd9753e0dcb4cad4432084 |
|
| MD5 | 1c29117b234e97a307e5d4032b593c14 |
|
| BLAKE2b-256 | 0ec7e818794aa355ab7599c0a9f5e4f4139754a9b1cf75d0592413315126d33c |
Hashes for django_girder_style-0.5.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fad161956f3035fbea9378ebd4e35c511acc9780fe467a425ca681750a116b87 |
|
| MD5 | 05131d125365ceca64e5844ac5c861d3 |
|
| BLAKE2b-256 | a4bc2146ddfbb08d9a9eacee58ffc3b1e8f2627aa85f960eea529f0b4a0e5ffd |