Material design for django forms and admin
Project description
Material design for Django Forms and Admin. Template driven.
Overview
Installation
django-material tested with Python 2.7/3.4, django 1.8, django 1.9:
pip install django-material
Forms
Add material into INSTALLED_APPS settings
INSTALLED_APPS = (
'material',
...
)
Include material javascript and styles along with jQuery into your base template.
{% include 'material/includes/material_css.html' %}
<script src="{% static 'material/js/jquery-2.2.0.js' %}"></script>
{% include 'material/includes/material_js.html' %}
Load the material_form template tag library
{% load material_form %}
And render your form with {% form %} template tag
<form method="POST">
{% csrf_token %}
{% form form=form %}{% endform %}
<button type="submit" name="_submit" class="btn">Submit</button>
</form>
Layout
Layout object is the way to specify relative fields placements and sizes.
from material import *
layout = Layout(
Row('shipment_no', 'description')
Fieldset("Add to inventory",
Row(Span3('product_name'), 'tags'),
Row('vendor', 'product_type'),
Row(Column('sku',
'stock_level',
span_columns=4),
'gender', 'desired_gender'),
Row('cost_price', Span2('wholesale_price'), 'retail_price')))
SpanXX elements are not to material grid classes, but used to determine relative fields width. Each row occupies 12 grid columns. Elements in Row(‘elem1’, ‘elem2’) would be rendered in 6 grid coulmns each, and in Row(Span2(‘elem1’), ‘elem2’) elem1 would be rendered in 8 grid columns, and elem2 in 4 grid columns.
Layouts rendering itself is specified in template.
ModelForm Views
Material forms library provides LayoutMixin for model form views, populates form fields list directly from layout object
from django import generic
from viewform import LayoutMixin
class SampleView(LayoutMixin, generic.ModelFormView):
layout = Layout(...)
Frontend
Frontend template assumes that your application contains a set of top level modules each one could restrict user access level and have own submenu.
To quick start add material.frontend into INSTALLED_APPS settings
INSTALLED_APPS = (
'material',
'material.frontend',
...
)
Add frontend urls into global urlconf module at urls.py
from material.frontend import urls as frontend_urls
urlpatterns = [
...
url(r'^admin/', include(admin.site.urls)),
url(r'', include(frontend_urls)),
]
The fronend module perform all required settings modification (add middleware, context_processors and template tags), automagically till MATERIAL_FRONTEND_AUTOREGISTER settings set to False.
To create a new module make a modules.py file, inside app directory, with following content
from material.frontend import Module
class Sample(Module):
icon = 'mdi-image-compare'
By default module expose a single view that renders html template from <module_name>/index.html file.
You can override Module.get_urls() method to provide module url config that would be automatically included into global urls.
To provide custom module menu, just create a template <module_name>/menu.html.
You can disable modules autodiscovery and explicitly list enabled modules in the MODULES setting
MODULES = (
'my_app.modules.Sample'
)
Admin
Add material.admin into INSTALLED_APPS settings
INSTALLED_APPS = (
'material',
'material.admin',
...
)
NOTE: ‘material.admin’ must be added before ‘django.contrib.admin’
Ensure that django.template.context_processors.request in your template context processor settings list
TEMPLATES = [
{
...
'OPTIONS': {
'context_processors': [
...
'django.template.context_processors.request',
...
],
},
},
]
You can provide a custom admin site module in the MATERIAL_ADMIN_SITE setting
MATERIAL_ADMIN_SITE = 'mymodule.admin.admin_site'
Admin support development is on initial stage. Only basic admin features are available.
Changelog
0.6.0 2016-02-22 - Alpha
First release with full django stardard widgets support
Forms - New per-widget demos on http://forms.viewflow.io/demo/widget/
Forms - Many widget behaviour fixes (DecimalInput, Select, MultiSelect, RadioInput)
Forms - Disable change datetime on mouse wheel
Admin - Style fixes and improvements
Admin - Custom form layouts support (ex: http://forms.viewflow.io/admin/sales/shipment/add/)
Admin - Admin css/js files moded to separate templates. Fix static files issue with CDN
Admin - Move All js/css dependencies inside the package. Meke it intranet app fiendly.
Frontend - Style fixes and improvements
Frontend - Fix load indicator on pjax back
Project details
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.