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.1, 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 %}.
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.
Compiling additional SCSS
If you're writing custom SCSS for your application, django-simple-bulma does provide a very basic mechanism for compiling
it for you. This is provided because, currently, django-simple-bulma will cause issues with current Django apps that exist
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": [
"myapp/static/css/base/base.scss"
],
}Please note: 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 static files directory. We attempt to do the same thing by parsing the given
path to your .scss file, using the following strategy:
- If a containing path exists in the
STATICFILES_DIRSsetting, assume that this is the base path to use, and the directory structure below it will be used to contain the resulting.cssfile - Otherwise, if the path contains
static/, assume that the base path ends there and use the rest of the path below it to contain the resulting.cssfile.
If both of these strategies fail to figure out what base path to use, an exception will be raised.
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 we will be happy to help you with it. Alternatively, head over to our discord server at https://discord.gg/python and we'll help you figure it out over chat.
