- Notifications
You must be signed in to change notification settings - Fork91
Integration of ViteJS in a Django project.
License
MrBin99/django-vite
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Integration ofViteJS in a Django project.
- Installation
- Usage
- Vite Legacy Plugin
- Multi-app configuration
- Configuration Variables
- Notes
- Examples
- Thanks
pip install django-viteAdddjango_vite to yourINSTALLED_APPS in yoursettings.py(before your apps that are using it).
INSTALLED_APPS= [ ...'django_vite', ...]
Follow instructions onhttps://vitejs.dev/guide/.And mostly the SSR part.
Then in your ViteJS config file :
- Set the
baseoptions the same as yourSTATIC_URLDjango setting. - Set the
build.outDirpath to where you want the assets to compiled. - Set the
build.manifestoptions tomanifest.json. - As you are in SSR and not in SPA, you don't have an
index.htmlthatViteJS can use to determine which files to compile. You need to tell itdirectly inbuild.rollupOptions.input.
exportdefaultdefineConfig({ ...base:"/static/",build:{ ...manifest:"manifest.json",outDir:resolve("./assets"),rollupOptions:{input:{<uniquekey>: '<pathtoyourasset>'}}}})
As recommended on Vite'sbackend integration guide, your assets should include the modulepreload polyfill.
// Add this at the beginning of your app entry.import'vite/modulepreload-polyfill';
Define a defaultDJANGO_VITE configuration in yoursettings.py.
DJANGO_VITE= {"default": {"dev_mode":True }}
Or if you prefer to use the legacy module-level settings, you can use:
DJANGO_VITE_DEV_MODE=True
Be sure that thebuild.outDir fromvite.config.js is included inSTATICFILES_DIRS.
STATICFILES_DIRS= [BASE_DIR/"assets"]
Thedev_mode/DJANGO_VITE_DEV_MODE boolean defines if you want to include assets in development mode or production mode.
- In development mode, assets are included as modules using the ViteJSwebserver. This will enable HMR for your assets.
- In production mode, assets are included as standard assets(no ViteJS webserver and HMR) like default Django static files.This means that your assets must be compiled with ViteJS before.
- This setting may be set as the same value as your
DEBUGsetting inDjango. But you can do what is good for your needs.
Include this in your base HTML template file.
{% load django_vite %}Then in your<head> element add this :
{% vite_hmr_client %}- This will add a
<script>tag to include the ViteJS HMR client. - This tag will include this script only if
DJANGO_VITE_DEV_MODEis true,otherwise this will do nothing.
Then add this tag (in your<head> element too) to load your scripts :
{% vite_asset '<path to your asset>' %}This will add a<script> tag including your JS/TS script :
- In development and production, all scripts are included as modules (
[type=module]). - You can pass a second argument to this tag to overrides attributespassed to the script tag.
- This tag only accept JS/TS, for other type of assets, they must beincluded in the script itself using
importstatements. - In production mode, the library will read the
manifest.jsonfilegenerated by ViteJS and import all CSS files dependent of this script(before importing the script). - You can add as many of this tag as you want, for each input you specifyin your ViteJS configuration file.
- The path must be relative to your
rootkey inside your ViteJS config file. - The path must be a key inside your manifest file
manifest.jsonfilegenerated by ViteJS.- Alternatively, the path can be an asset name (e.g.
"name": "foo"in your manifest).If you set up multiple entrypoints (build.rollupOptions.input) in your Vite config,e.g. by followingthe Multi-Page Appdocs, this would be the key in the entrypoint object.
- Alternatively, the path can be an asset name (e.g.
- In general, this path does not require a
/at the beginning(follow yourmanifest.jsonfile).
{% vite_asset_url '<path to your asset>' %}This will generate only the URL to an asset with no tag surrounding it.Warning, this does not generate URLs for dependant assets of this onelike the previous tag.
{% vite_react_refresh %}If you're using React, this will generate the Javascript<script/> needed to support React HMR.
{% vite_react_refresh nonce="{{ request.csp_nonce }}" %}Any kwargs passed to vite_react_refresh will be added to its generated<script/> tag. For example, if your site is configured with a Content Security Policy usingdjango-csp you'll want to add this value fornonce.
By default, all script tags are generated with atype="module" andcrossorigin="" attributes just like ViteJS do by default if you are building a single-page app.You can override this behavior by adding or overriding this attributes like so :
{% vite_asset '<path to your asset>' foo="bar" hello="world" data_turbo_track="reload" %}This line will addfoo="bar",hello="world", anddata-turbo-track="reload" attributes.
You can also use context variables to fill attributes values :
{% vite_asset '<path to your asset>' foo=request.GET.bar %}If you want to overrides default attributes just add them like new attributes :
{% vite_asset '<path to your asset>' crossorigin="anonymous" %}Although it's recommended to keep the defaulttype="module" attribute as ViteJS build scripts as ES6 modules.
By default, django-vite will try to load a localmanifest.json.
If you want django-vite to fetch the manifest from a non-standard source like S3, you can subclass DjangoViteAppClient and override its ManifestClient. Below is a minimal example:
# myapp/django_vite_s3.pyimportjsonimportboto3fromdjango_vite.core.asset_loaderimportManifestClient,DjangoViteAppClientclassS3ManifestClient(ManifestClient):defload_manifest(self):s3=boto3.client("s3")res=s3.get_object(Bucket='django-vite-public-example',Key='manifest.json')manifest_content=res["Body"].read()returnjson.loads(manifest_content)classS3DjangoViteAppClient(DjangoViteAppClient):ManifestClient=S3ManifestClient
Then configure your app to use your customS3DjangoViteAppClient:
# settings.pyfromdjango_vite.core.asset_loaderimportDjangoViteConfigDJANGO_VITE= {"default":DjangoViteConfig(dev_mode=False,app_client_class="myapp.django_vite_s3.S3DjangoViteAppClient", ... )}
If your "django.contrib.staticfiles" is configured to use S3, then your assets should load properly without needing further configuration.
Since this feature support is a new work-in-progress, please share with the community any configurations that have worked well for you!
If you find yourself needing greater control over how static asset urls are rendered, you can modifyDjangoViteAppClient.get_production_server_url:
# myapp/django_vite_s3.pyimportjsonimportboto3fromdjango_vite.core.asset_loaderimportManifestClient,DjangoViteAppClientclassS3ManifestClient(ManifestClient):defload_manifest(self):s3=boto3.client("s3")res=s3.get_object(Bucket='django-vite-public-example',Key='manifest.json')manifest_content=res["Body"].read()returnjson.loads(manifest_content)classS3DjangoViteAppClient(DjangoViteAppClient):ManifestClient=S3ManifestClientdefget_production_server_url(self,path:str)->str:# Make additional charge here as needed ...
If you want to consider legacy browsers that don't support ES6 modules loadingyou may use@vitejs/plugin-legacy.Django Vite supports this plugin. You must add stuff in complement of other script imports in the<head> tag.
Just before your<body> closing tag add this :
{% vite_legacy_polyfills %}This tag will do nothing in development, but in production it will loads the polyfillsgenerated by ViteJS.
And so next to this tag you need to add another import to all the scripts you havein the head but the 'legacy' version generated by ViteJS like so :
{% vite_legacy_asset '<path to your asset>' %}Like the previous tag, this will do nothing in development but in production,Django Vite will add a script tag with anomodule attribute for legacy browsers.The path to your asset must contain de pattern-legacy in the file name (ex :main-legacy.js).
This tag accepts overriding and adding custom attributes like the defaultvite_asset tag.
If you would like to use django-vite with multiple vite configurations you can specify them in your settings.
DJANGO_VITE= {"default": {"dev_mode":True, },"external_app_1": { ... },"external_app_2": { ... }}
Specify the app in each django-tag tag that you use in your templates. If no app is provided, it will default to using the "default" app.
{% vite_asset '<pathtoyourasset>' %}{% vite_asset '<pathtoanotherasset>' app="external_app_1" %}{% vite_asset '<pathtoathirdasset>' app="external_app_2" %}You can see an example projecthere.
You can redefine these values for each app config inDJANGO_VITE insettings.py.
- Type:
bool - Default:
False - Legacy Key:
DJANGO_VITE_DEV_MODE
Indicates whether to serve assets via the ViteJS development server or from compiled production assets.
Read more:Dev Mode
- Type:
str - Default:
"http" - Legacy Key:
DJANGO_VITE_DEV_SERVER_PROTOCOL
The protocol used by the ViteJS webserver.
- Type:
str - Default:
"localhost" - Legacy Key:
DJANGO_VITE_DEV_SERVER_HOST
Theserver.host invite.config.js for the ViteJS development server.
- Type:
int - Default:
5173 - Legacy Key:
DJANGO_VITE_DEV_SERVER_PORT
Theserver.port invite.config.js for the ViteJS development server.
- Type:
str - Default:
"" - Legacy Key:
DJANGO_VITE_STATIC_URL_PREFIX
The directory prefix for static files built by ViteJS.
- Use it if you want to avoid conflicts with other static files in your project.
- It's used in both dev mode and production mode.
- For dev mode, you also need to add this prefix inside vite config's
base. - For production mode, you may need to add this to vite config's
build.outDir.
Example:
# settings.pyDJANGO_VITE_STATIC_URL_PREFIX='bundler'STATICFILES_DIRS= (('bundler','/srv/app/bundler/dist'),)
// vite.config.jsexportdefaultdefineConfig({base:'/static/bundler/', ...})
- Type:
str | Path - Default:
Path(settings.STATIC_ROOT) / static_url_prefix / "manifest.json" - Legacy Key:
DJANGO_VITE_MANIFEST_PATH
The absolute path, including the filename, to the ViteJS manifest file located inbuild.outDir.
- Type:
str - Default:
"legacy-polyfills" - Legacy Key:
DJANGO_VITE_LEGACY_POLYFILLS_MOTIF
The motif used to identify assets for polyfills in themanifest.json. This is only applicable if you are using@vitejs/plugin-legacy.
- Type:
str - Default:
"@vite/client" - Legacy Key:
DJANGO_VITE_WS_CLIENT_URL
The path to the HMR (Hot Module Replacement) client used in thevite_hmr_client tag.
- Type:
str - Default:
"@react-refresh"" - Legacy Key:
DJANGO_VITE_REACT_REFRESH_URL
If you're using React, this will generate the Javascript needed to support React HMR.
- Type:
str - Default:
"django_vite.core.asset_loader.DjangoViteAppClient"
This is the fully qualified name of a Python class that extends or replacesDjangoViteAppClient. This allows you to customize almost any part of django-vite's loader behavior. The most requested reason for adding this feature is customizing howmanifest.json is loaded.
SeeLoading assets from a CDN for an example of using a custom class to load the manifest from S3.
- In production mode, all generated paths are prefixed with the
STATIC_URLsetting of Django.
If you are serving your static files with whitenoise, by default your files compiled by vite will not be considered immutable and a bad cache-control will be set. To fix this you will need to set a custom test like so:
importre# http://whitenoise.evans.io/en/stable/django.html#WHITENOISE_IMMUTABLE_FILE_TESTdefimmutable_file_test(path,url):# Match vite (rollup)-generated hashes, à la, `some_file-CSliV9zW.js`returnre.match(r"^.+[.-][0-9a-zA-Z_-]{8,12}\..+$",url)WHITENOISE_IMMUTABLE_FILE_TEST=immutable_file_test
For examples of how to setup the project in v3, please seedjango-vite-examples.
For another example that uses the module-level legacy settings, please see thisexample project here.
Thanks toEvan You for the ViteJS library.
About
Integration of ViteJS in a Django project.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.