Django application to add the Bulma CSS framework and its extensions
Project description
django-simple-bulma
django-simple-bulma is a Django application that makes Bulma
and Bulma-Extensions available to use in your Django project with as little setup as
possible. The goal of this project is to make it as easy as possible to use Bulma with Django.
This project currently uses Bulma v0.9.2, and is automatically updated with every new release. If a new version has come out with features you'd like to make use of, please create an issue, and we will be happy to make a release to update it.
Installation
To get django-simple-bulma, up and running for your Django project, follow these simple steps:
-
Install it from PyPI with
pip install django-simple-bulma(or add it to your Pipfile) -
In your Django projects
settings.pyfile:- Add
django_simple_bulmato yourINSTALLED_APPSINSTALLED_APPS = [ # ... 'django_simple_bulma', # ... ]
- Add
django_simple_bulma.finders.SimpleBulmaFinderto yourSTATICFILES_FINDERS. This normally holds two default handlers that you will probably want to keep, so unless you have any other custom Finders, it should look like this:STATICFILES_FINDERS = [ # First add the two default Finders, since this will overwrite the default. 'django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder', # Now add our custom SimpleBulma one. 'django_simple_bulma.finders.SimpleBulmaFinder', ]
- Add
-
Run
python manage.py collectstaticcommand in order to build Bulma and move it to yourstaticfilesfolder. Please note that you will need to use this command every time you make a change to the configuration, as this is the only way to rebuild the Bulma css file. If you are not usingcollectstatic, read up on it and start using it.This app works fine with Whitenoise, which is a great way to serve static files without needing to mess with your webserver.
django-simple-bulma should now be working! In order to import it into your template, first load the app
with {% load django_simple_bulma %}, and then use the {% bulma %} template tag. If you're planning on using icons,
you might also want to import FontAwesome by using {% font_awesome %}.
<head>
<!-- ... -->
{% load django_simple_bulma %}
{% bulma %}
{% font_awesome %}
<!-- ... -->
</head>
- You're all set! Any Bulma classes you apply should now be working!
Customization
Bulma looks nice by default, but most users will want to customize its look and feel. For this, we've provided a super simple way to change the Bulma variables and to choose which Bulma extensions you want to load into your project.
In order to do this, we'll simply create a dictionary inside your settings.py called BULMA_SETTINGS, and configure
it there. Here's an example of what that looks like:
# Custom settings for django-simple-bulma
BULMA_SETTINGS = {
"extensions": [
"bulma-collapsible",
"bulma-calendar",
],
"variables": {
"primary": "#000000",
"size-1": "6rem",
},
"alt_variables": {
"primary": "#fff",
"scheme-main": "#000",
},
"output_style": "compressed",
"fontawesome_token": "e761a01be3",
}
You may here define any variable found on the Bulma variables
page, and you may use any valid SASS or CSS as the value. For example, hsl(217, 71%, 53%) would be a valid value for a
color variable, as would #ffff00. Please note that any syntactically incorrect values may prevent Bulma from building
correctly, so be careful what you add here unless you know exactly what you're doing.
Multiple themes
If you want multiple different configurations of variables, then you should define them as separate themes. Define a new
theme by providing a key that matches the regex \w+_variables (e.g. alt_variables or dark_variables), unique
stylesheets will then be generated using the variables at that key.
To use these stylesheets in a template, pass the theme name to the {% bulma %} tag either as a
string {% bulma 'alt' %} or as a template variable {% bulma theme %}. When calling the bulma template
more than once in the same document (for example for implementing a dark theme switch), you will want to pass include_js=False to
at least one of these to prevent duplicate loading of JavaScript resources.
Extensions
If the extensions key is not found, it will default to not loading any extensions. If you want all extensions, simply
set it to the string "all".
We currently support these extensions:
- bulma-badge
- bulma-calendar
- bulma-carousel
- bulma-collapsible
- bulma-checkradio
- bulma-divider
- bulma-megamenu
- bulma-pageloader
- bulma-pricingtable
- bulma-quickview
- bulma-ribbon
- bulma-slider
- bulma-steps
- bulma-switch
- bulma-tagsinput
- bulma-timeline
- bulma-tooltip
- bulma-coolcheckboxes (Cool-Checkboxes-for-Bulma.io)
If an extension you want to use is missing, feel free to create an issue and we will be happy to add it. Alternatively, add it yourself and create a pull request ( see this pr for some context on how to go about doing that).
CSS style
The output_style parameter determines the style of the resulting CSS file. It can be any of "nested" (default)
, "expanded", "compact", and "compressed". It is recommended to use "compressed" in production as to reduce the
final file size.
FontAwesome
The optional fontawesome_token parameter allows you to specify your personal FontAwesome kit, which is necessary for
FontAwesome v6 and up. This should be set to the identifier part of your FontAwesome kit script src parameter. For
example, if your FontAwesome kit looks like this:
<script src="https://kit.fontawesome.com/e761a01be3.js" crossorigin="anonymous"></script>
Then your fontawesome_token should be e761a01be3.
This is used by the {% font_awesome %} template tag to set up FontAwesome for you. If you don't specify
a fontawesome_token, the template tag will still work, but will then use an older version of FontAwesome (v5.14.0)
.
Additional scripts
For your convenience, we also give you the option to add other quality of life improvements to your Bulma app. You may want to add these as well if they sound useful to you.
bulma-fileuploadwill handle displaying the filename in your file upload inputs.bulma-navbar-burgerwill hook up yournavbar-burgers andnavbar-menus automatically, to provide a toggle for mobile users. We use a slightly updated version of the example from Bulma's documentation - simply add adata-targetattribute to yournavbar-burgerthat refers to theidof thenavbar-menuthat should be expanded and collapsed by the button.bulma-notificationswill allow you to close notifications by clicking on the X button.bulma-dropdownwill open/close dropdowns using theis-activeclass. It mimics how the dropdowns function on the documentation page.bulma-modalwill handle opening and closing modals. Just assign themodal-buttonclass to a<button>, and make sure it has adata-targetattribute that matches theidof the modal that you want to open. See the example code from Bulma's documentation for modal element code.
Compiling custom SCSS
If you're writing custom SCSS for your application, django-simple-bulma provides a mechanism for compiling it for you.
This is provided mainly because django-simple-bulma may cause conflicts and issues with other tools to compile SCSS
for you.
To use this feature, please specify the custom_css key when defining your BULMA_SETTINGS. This should be a list of
strings, containing relative paths to .scss files to be compiled.
BULMA_SETTINGS = {
"custom_scss": [
"css/base/base.scss", # This is okay
"my_app/static/css/base/base.scss", # This also is okay
"C:\Users\MainDawg\my_app\static\..." # Don't do this, though.
],
}
The default Django behavior when collecting static files is to keep the containing file structure for them when they're copied over to the final staticfiles directory. We do the same thing, so all directories and subdirectories will still be intact in your staticfiles folder after they've been collected.
Here's the strategy the finder uses:
- If your path contains
static/, assume that the base path ends there and use the rest of the path as a relative path to the resource. - Use whatever Finders you have enabled in your
settings.pyto search for the file using that relative path. - If the path is found using one of these Finders, compile it to css and collect it.
- Otherwise, raise a
ValueExceptionasking you to double-check the filepath.
Troubleshooting
- If you have the module
sassinstalled, please note that it is incompatible with this project. There is a namespace conflict betweensassandlibsasswhich will makedjango-simple-bulmacrash when you attempt to do acollectstatic. To solve this, just uninstallsassand uselibsassinstead.
If you run into any other problems with this app,
please create an issue, and I'll will be happy to help
you with it. You can also find me on Discord as lemon#0001 - either at #django-simple-bulma in the lemonsaurus discord or at https://discord.gg/python.
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
File details
Details for the file django-simple-bulma-2.6.0.tar.gz.
File metadata
- Download URL: django-simple-bulma-2.6.0.tar.gz
- Upload date:
- Size: 429.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7660aac87f3bfb23f2bbbd564e216337f443c001698d344759ad5753f8e3a3c1 |
|
| MD5 | 8a17ea99ad6e7883a7e34e1885f13765 |
|
| BLAKE2b-256 | 09466bce02277e67407d1bdfd4f71d30d5bdb370e63bbbf3daef68cad7d593ab |
File details
Details for the file django_simple_bulma-2.6.0-py3-none-any.whl.
File metadata
- Download URL: django_simple_bulma-2.6.0-py3-none-any.whl
- Upload date:
- Size: 489.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 06a195e630f9bfa91060a0075a18ba6953bb72e7396fda3737561af0dfeab0d1 |
|
| MD5 | 286f7f6a15d15122dc9457bac7bd5110 |
|
| BLAKE2b-256 | c407771daba2ba0efee17ece758c6d384d6ce3eb83f2c1d6f4ce956408a2cd1c |
