Bring `postcss-modules` to your django project, transpiling static .cssm files on the fly, without NodeJS require!
Project description
django-postcss-modules
Bring postcss-modules
to your django project, transpiling static .cssm files on the fly, without NodeJS require!
Install
pip install django-postcss-modules
Static files transpiling config
- Add
postcss_modules
to your djangoINSTALLED_APPS
- Add
postcss_modules.middlewares.PostCSSModulesMiddleware
to your djangoMIDDLEWARE
note the order
[ ... 'postcss_modules.middlewares.PostCSSModulesMiddleware', 'whitenoise.middleware.WhiteNoiseMiddleware', ... ]
- Config django
STATICFILES_STORAGE = 'postcss_modules.storage.PostCSSModulesStorage'
Global Options
Default options is:
{
'polyfill': 'postcss-modules-v8-polyfill.js',
'transpiler': 'npm/postcss-modules-standalone@1.0.1/index.bundle.min.js',
'setup': 'postcss-modules-setup.js',
'extensions': ['.cssm'],
'mimetypes': {
'.cssm': 'text/css'
},
'max_time': 3 # transpiling max wait time, in second
}
You can customize by provide POSTCSS_MODULES
in your django settings, for example, custom max time:
POSTCSS_MODULES = {
'max_time': 30
}
Template Support
Sometimes transpiling in your template file is more make sense than static file,
you can use postcssmodules
tag to do that.
{% load static postcss_modules %}
...
<style id="indexStyles">
{% postcssmodules %}
:global .page {
padding: 20px;
}
@value hi from '{% static "myapp/css/consts.cssm" %}';
.title {
composes: title from "{% static "myapp/css/mixins.cssm" %}";
color: green;
}
.article {
font-size: 16px;
color: hi;
}
{% endpostcssmodules %}
</style>
...
<script>
const _styles = document.querySelector('#indexStyles').sheet
const styles = JSON.parse(_styles.cssRules[_styles.cssRules.length - 1].style.getPropertyValue('--json'));
element.innerHTML = '<div class="' + styles.title + '">';
</script>
...
Template tag also support use custom transpiling option, for example:
{% postcssmodules max_time=30 %}
.title {
composes: title from "{% static "myapp/css/mixins.cssm" %}";
color: green;
}
{% endpostcssmodules %}
FAQ
-
Static file not get transpiled
if you use django
runserver
command to run server and the settingDEBUG=True
, please add--nostatic
option to command -
I want use other storage
you should write your own storage to inherit
PostCSSModulesStorage
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.
Source Distribution
Built Distribution
Hashes for django-postcss-modules-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e9869144df445e636f85fa3f9dd0af10685995444073e05585e191dd293648d |
|
MD5 | afe0ee4f57be2da3edb7cd8bed5ff779 |
|
BLAKE2b-256 | 9f82c2b3ac04a4dd3458b5bdd2699b843b93d8b94daa44b1d7148885455de79b |
Hashes for django_postcss_modules-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70bcb2b22f1417ae9450eecfdab680c08daeb6c2ed2d6f975eb91f31e102641b |
|
MD5 | 21b79db42ecf29520818240586895aa3 |
|
BLAKE2b-256 | 486e1157e706759556ca3d7fa5897ad08d5db9506b3399227a7a403734f3b253 |