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
django-allauth Support
To enable support for django-allauth, install with:
pip install django-girder-style[allauth]
Then enable the 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',
...,
# "allauth" must come after "girder_style"
'allauth',
'allauth.account',
'allauth.socialaccount',
]
django-oauth-toolkit Support
To enable support for django-oauth-toolkit, install with:
pip install django-girder-style[oauth-toolkit]
Then enable the 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 "oauth2_provider" is installed, it must come after "girder_style"
'oauth2_provider',
]
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.7.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 27542b46825907a252ad7c18b9b649f6a8ee4970cb10382cdd0f977c14f41a9b |
|
| MD5 | 5577810eef4f0bfebc2c18171724ec49 |
|
| BLAKE2b-256 | 0be8e67c4c614175dd0e2d09babe8e62d3f8fd08c733cb66d32b438d6ef27394 |
Hashes for django_girder_style-0.7.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 92af32c41a24f2baa7d1542c499c10501ffd616d20e92484b2b6ef85f65c28db |
|
| MD5 | 8b2bd5a13fc176b65beaa29c2ed84a60 |
|
| BLAKE2b-256 | d4a6630d8c987e7f182fb1d89091c047c9cd2619d27a2d2a8f37891167c638e5 |