Package: django-vite
Django ViteIntegration ofViteJSin a Django project.InstallationDjangoViteJSAssetsUsageConfigurationDev ModeTemplate tagsCustom attributesVite Legacy PluginMulti-app configurationConfiguration Variablesdev_modedev_server_protocoldev_server_hostdev_server_portstatic_url_prefixmanifest_pathlegacy_polyfills_motifws_client_urlreact_refresh_urlNotesWhitenoiseExamplesThanksInstallationDjangopip install django-viteAdddjango_viteto yourINSTALLED_APPSin yoursettings.py(before your apps that are using it).INSTALLED_APPS=[...'django_vite',...]ViteJSFollow instructions onhttps://vitejs.dev/guide/.
And mostly the SSR part.Then in your ViteJS config file :Set thebaseoptions the same as yourSTATIC_URLDjango setting.Set thebuild.outDirpath to where you want the assets to compiled.Set thebuild.manifestoptions tomanifest.json.As you are in SSR and not in SPA, you don't have anindex.htmlthat
ViteJS can use to determine which files to compile. You need to tell it
directly inbuild.rollupOptions.input.exportdefaultdefineConfig({...base:"/static/",build:{...manifest:"manifest.json",outDir:resolve("./assets"),rollupOptions:{input:{<uniquekey>:'<path to your asset>'}}}})AssetsAs 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';UsageConfigurationDefine a defaultDJANGO_VITEconfiguration 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=TrueBe sure that thebuild.outDirfromvite.config.jsis included inSTATICFILES_DIRS.STATICFILES_DIRS=[BASE_DIR/"assets"]Dev ModeThedev_mode/DJANGO_VITE_DEV_MODEboolean defines if you want to include assets in development mode or production mode.In development mode, assets are included as modules using the ViteJS
webserver. 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 yourDEBUGsetting in
Django. But you can do what is good for your needs.Template tagsInclude 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 ifDJANGO_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 mode, all scripts are included as modules.In development mode, all scripts are marked asasyncanddefer.You can pass a second argument to this tag to overrides attributes
passed to the script tag.This tag only accept JS/TS, for other type of assets, they must be
included in the script itself usingimportstatements.In production mode, the library will read themanifest.jsonfile
generated 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 specify
in your ViteJS configuration file.The path must be relative to yourrootkey inside your ViteJS config file.The path must be a key inside your manifest filemanifest.jsonfile
generated by ViteJS.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 one
like 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-cspyou'll want to add this value fornonce.Custom attributesBy 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" %}This line will addfoo="bar"andhello="world"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.Vite Legacy PluginIf you want to consider legacy browsers that don't support ES6 modules loading
you 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 polyfills
generated by ViteJS.And so next to this tag you need to add another import to all the scripts you have
in 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 anomoduleattribute for legacy browsers.
The path to your asset must contain de pattern-legacyin the file name (ex :main-legacy.js).This tag accepts overriding and adding custom attributes like the defaultvite_assettag.Multi-app configurationIf 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.Configuration VariablesYou can redefine these values for each app config inDJANGO_VITEinsettings.py.dev_modeType:boolDefault:FalseLegacy Key:DJANGO_VITE_DEV_MODEIndicates whether to serve assets via the ViteJS development server or from compiled production assets.Read more:Dev Modedev_server_protocolType:strDefault:"http"Legacy Key:DJANGO_VITE_DEV_SERVER_PROTOCOLThe protocol used by the ViteJS webserver.dev_server_hostType:strDefault:"localhost"Legacy Key:DJANGO_VITE_DEV_SERVER_HOSTTheserver.hostinvite.config.jsfor the ViteJS development server.dev_server_portType:intDefault:5173Legacy Key:DJANGO_VITE_DEV_SERVER_PORTTheserver.portinvite.config.jsfor the ViteJS development server.static_url_prefixType:strDefault:""Legacy Key:DJANGO_VITE_STATIC_URL_PREFIXThe 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'sbase.For production mode, you may need to add this to vite config'sbuild.outDir.Example:# settings.pyDJANGO_VITE_STATIC_URL_PREFIX='bundler'STATICFILES_DIRS=(('bundler','/srv/app/bundler/dist'),)// vite.config.jsexportdefaultdefineConfig({base:'/static/bundler/',...})manifest_pathType:str | PathDefault:Path(settings.STATIC_ROOT) / static_url_prefix / "manifest.json"Legacy Key:DJANGO_VITE_MANIFEST_PATHThe absolute path, including the filename, to the ViteJS manifest file located inbuild.outDir.legacy_polyfills_motifType:strDefault:"legacy-polyfills"Legacy Key:DJANGO_VITE_LEGACY_POLYFILLS_MOTIFThe motif used to identify assets for polyfills in themanifest.json. This is only applicable if you are using@vitejs/plugin-legacy.ws_client_urlType:strDefault:"@vite/client"Legacy Key:DJANGO_VITE_WS_CLIENT_URLThe path to the HMR (Hot Module Replacement) client used in thevite_hmr_clienttag.react_refresh_urlType:strDefault:"@react-refresh""Legacy Key:DJANGO_VITE_REACT_REFRESH_URLIf you're using React, this will generate the Javascript needed to support React HMR.NotesIn production mode, all generated paths are prefixed with theSTATIC_URLsetting of Django.WhitenoiseIf 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# Vite generates files with 8 hash digits# http://whitenoise.evans.io/en/stable/django.html#WHITENOISE_IMMUTABLE_FILE_TESTdefimmutable_file_test(path,url):# Match filename with 12 hex digits before the extension# e.g. app.db8f2edc0c8a.jsreturnre.match(r"^.+[\.\-][0-9a-f]{8,12}\..+$",url)WHITENOISE_IMMUTABLE_FILE_TEST=immutable_file_testExamplesFor 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.ThanksThanks toEvan Youfor the ViteJS library.