mirror of
https://github.com/django-components/django-components.git
synced 2025-08-15 19:50:13 +00:00
1741 lines
No EOL
507 KiB
HTML
1741 lines
No EOL
507 KiB
HTML
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="A way to create simple reusable template components in Django."><link href=https://emilstenstrom.github.io/django-components/latest/ rel=canonical><link href=CHANGELOG/ rel=next><link rel=icon href=assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.5.43"><title>Index - Django-Components</title><link rel=stylesheet href=assets/stylesheets/main.0253249f.min.css><link rel=stylesheet href=assets/stylesheets/palette.06af60db.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=assets/_markdown_exec_pyodide.css><link rel=stylesheet href=assets/_mkdocstrings.css><link rel=stylesheet href=css/timeago.css><script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta property=og:type content=website><meta property=og:title content="Index - Django-Components"><meta property=og:description content="A way to create simple reusable template components in Django."><meta property=og:image content=https://emilstenstrom.github.io/django-components/latest/assets/images/social/README.png><meta property=og:image:type content=image/png><meta property=og:image:width content=1200><meta property=og:image:height content=630><meta content=https://emilstenstrom.github.io/django-components/latest/ property=og:url><meta name=twitter:card content=summary_large_image><meta name=twitter:title content="Index - Django-Components"><meta name=twitter:description content="A way to create simple reusable template components in Django."><meta name=twitter:image content=https://emilstenstrom.github.io/django-components/latest/assets/images/social/README.png></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#_1 class=md-skip> Skip to content </a> </div> <div data-md-component=announce> <aside class=md-banner> <div class="md-banner__inner md-grid md-typeset"> 🚨The documentation is still a work in progress. 🚨 </div> </aside> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=. title=Django-Components class="md-header__button md-logo" aria-label=Django-Components data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Django-Components </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Index </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media=(prefers-color-scheme) data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=teal data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=teal data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <a href=javascript:void(0) class="md-search__icon md-icon" title=Share aria-label=Share data-clipboard data-clipboard-text data-md-component=search-share tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg> </a> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/EmilStenstrom/django-components title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> EmilStenstrom/django-components </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=. title=Django-Components class="md-nav__button md-logo" aria-label=Django-Components data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> Django-Components </label> <div class=md-nav__source> <a href=https://github.com/EmilStenstrom/django-components title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> EmilStenstrom/django-components </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1 checked> <div class="md-nav__link md-nav__container"> <a href=. class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> README </span> </a> <label class="md-nav__link md-nav__link--active" for=__nav_1 id=__nav_1_label tabindex> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=true> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> README </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=CHANGELOG/ class=md-nav__link> <span class=md-ellipsis> Changelog </span> </a> </li> <li class=md-nav__item> <a href=CODE_OF_CONDUCT/ class=md-nav__link> <span class=md-ellipsis> Code of Conduct </span> </a> </li> <li class=md-nav__item> <a href=license/ class=md-nav__link> <span class=md-ellipsis> License </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1> <label class=md-nav__link for=__nav_2_1 id=__nav_2_1_label tabindex=0> <span class=md-ellipsis> API Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_1_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1> <span class="md-nav__icon md-icon"></span> API Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_1> <div class="md-nav__link md-nav__container"> <a href=reference/django_components/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> django_components </span> </a> <label class="md-nav__link " for=__nav_2_1_1 id=__nav_2_1_1_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_2_1_1_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_1> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> django_components </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/django_components/app_settings/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> app_settings </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/apps/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> apps </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/attributes/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> attributes </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/autodiscovery/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> autodiscovery </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/component/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> component </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/component_media/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> component_media </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/component_registry/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> component_registry </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_1_9> <div class="md-nav__link md-nav__container"> <a href=reference/django_components/components/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> components </span> </a> <label class="md-nav__link " for=__nav_2_1_1_9 id=__nav_2_1_1_9_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=4 aria-labelledby=__nav_2_1_1_9_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_1_9> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> components </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/django_components/components/dynamic/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> dynamic </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=reference/django_components/context/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> context </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/dependencies/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> dependencies </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/expression/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> expression </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/finders/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> finders </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/library/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> library </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_1_15> <div class="md-nav__link md-nav__container"> <a href=reference/django_components/management/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> management </span> </a> <label class="md-nav__link " for=__nav_2_1_1_15 id=__nav_2_1_1_15_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=4 aria-labelledby=__nav_2_1_1_15_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_1_15> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> management </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_1_15_2> <div class="md-nav__link md-nav__container"> <a href=reference/django_components/management/commands/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> commands </span> </a> <label class="md-nav__link " for=__nav_2_1_1_15_2 id=__nav_2_1_1_15_2_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=5 aria-labelledby=__nav_2_1_1_15_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_1_15_2> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> commands </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/django_components/management/commands/startcomponent/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> startcomponent </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/management/commands/upgradecomponent/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> upgradecomponent </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=reference/django_components/middleware/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> middleware </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/node/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> node </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/provide/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> provide </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/slots/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> slots </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/tag_formatter/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> tag_formatter </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/template/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> template </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/template_loader/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> template_loader </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/template_parser/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> template_parser </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_1_24> <div class="md-nav__link md-nav__container"> <a href=reference/django_components/templatetags/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> templatetags </span> </a> <label class="md-nav__link " for=__nav_2_1_1_24 id=__nav_2_1_1_24_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=4 aria-labelledby=__nav_2_1_1_24_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_1_24> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> templatetags </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/django_components/templatetags/component_tags/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> component_tags </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=reference/django_components/types/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> types </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/urls/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> urls </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_1_27> <div class="md-nav__link md-nav__container"> <a href=reference/django_components/util/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> util </span> </a> <label class="md-nav__link " for=__nav_2_1_1_27 id=__nav_2_1_1_27_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=4 aria-labelledby=__nav_2_1_1_27_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_1_27> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> util </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/django_components/util/cache/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> cache </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/html/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> html </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/loader/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> loader </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/logger/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> logger </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/misc/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> misc </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/nanoid/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> nanoid </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/tag_parser/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> tag_parser </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/types/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> types </span> </a> </li> <li class=md-nav__item> <a href=reference/django_components/util/validation/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> validation </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_2> <div class="md-nav__link md-nav__container"> <a href=reference/django_components_js/build/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> django_components_js </span> </a> </div> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_2_1_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_2> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> django_components_js </label> <ul class=md-nav__list data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_3> <div class="md-nav__link md-nav__container"> <a href=reference/docs/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> docs </span> </a> <label class="md-nav__link " for=__nav_2_1_3 id=__nav_2_1_3_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_2_1_3_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_3> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> docs </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_1_3_2> <div class="md-nav__link md-nav__container"> <a href=reference/docs/scripts/ class="md-nav__link "> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> scripts </span> </a> <label class="md-nav__link " for=__nav_2_1_3_2 id=__nav_2_1_3_2_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=4 aria-labelledby=__nav_2_1_3_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2_1_3_2> <span class="md-nav__icon md-icon"></span> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> scripts </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/docs/scripts/reference/ class=md-nav__link> <span class=md-ellipsis> <code class="doc-symbol doc-symbol-nav doc-symbol-module"></code> reference </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#features class=md-nav__link> <span class=md-ellipsis> Features </span> </a> </li> <li class=md-nav__item> <a href=#quickstart class=md-nav__link> <span class=md-ellipsis> Quickstart </span> </a> </li> <li class=md-nav__item> <a href=#table-of-contents class=md-nav__link> <span class=md-ellipsis> Table of Contents </span> </a> </li> <li class=md-nav__item> <a href=#release-notes class=md-nav__link> <span class=md-ellipsis> Release notes </span> </a> </li> <li class=md-nav__item> <a href=#security-notes class=md-nav__link> <span class=md-ellipsis> Security notes 🚨 </span> </a> <nav class=md-nav aria-label="Security notes 🚨"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#static-files class=md-nav__link> <span class=md-ellipsis> Static files </span> </a> <nav class=md-nav aria-label="Static files"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#static-files-prior-to-v0100 class=md-nav__link> <span class=md-ellipsis> Static files prior to v0.100 </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#installation class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> <nav class=md-nav aria-label=Installation> <ul class=md-nav__list> <li class=md-nav__item> <a href=#adding-support-for-js-and-css class=md-nav__link> <span class=md-ellipsis> Adding support for JS and CSS </span> </a> </li> <li class=md-nav__item> <a href=#optional class=md-nav__link> <span class=md-ellipsis> Optional </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#compatibility class=md-nav__link> <span class=md-ellipsis> Compatibility </span> </a> </li> <li class=md-nav__item> <a href=#create-your-first-component class=md-nav__link> <span class=md-ellipsis> Create your first component </span> </a> </li> <li class=md-nav__item> <a href=#using-single-file-components class=md-nav__link> <span class=md-ellipsis> Using single-file components </span> </a> <nav class=md-nav aria-label="Using single-file components"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#syntax-highlight-and-code-assistance class=md-nav__link> <span class=md-ellipsis> Syntax highlight and code assistance </span> </a> <nav class=md-nav aria-label="Syntax highlight and code assistance"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#vscode class=md-nav__link> <span class=md-ellipsis> VSCode </span> </a> </li> <li class=md-nav__item> <a href=#pycharm-or-other-jetbrains-ides class=md-nav__link> <span class=md-ellipsis> Pycharm (or other Jetbrains IDEs) </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#use-components-in-templates class=md-nav__link> <span class=md-ellipsis> Use components in templates </span> </a> </li> <li class=md-nav__item> <a href=#use-components-outside-of-templates class=md-nav__link> <span class=md-ellipsis> Use components outside of templates </span> </a> <nav class=md-nav aria-label="Use components outside of templates"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#inputs-of-render-and-render_to_response class=md-nav__link> <span class=md-ellipsis> Inputs of render and render_to_response </span> </a> <nav class=md-nav aria-label="Inputs of render and render_to_response"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#slotfunc class=md-nav__link> <span class=md-ellipsis> SlotFunc </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#response-class-of-render_to_response class=md-nav__link> <span class=md-ellipsis> Response class of render_to_response </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#use-components-as-views class=md-nav__link> <span class=md-ellipsis> Use components as views </span> </a> <nav class=md-nav aria-label="Use components as views"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#component-as-view-example class=md-nav__link> <span class=md-ellipsis> Component as view example </span> </a> </li> <li class=md-nav__item> <a href=#modifying-the-view-class class=md-nav__link> <span class=md-ellipsis> Modifying the View class </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#typing-and-validating-components class=md-nav__link> <span class=md-ellipsis> Typing and validating components </span> </a> <nav class=md-nav aria-label="Typing and validating components"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#adding-type-hints-with-generics class=md-nav__link> <span class=md-ellipsis> Adding type hints with Generics </span> </a> <nav class=md-nav aria-label="Adding type hints with Generics"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#usage-for-python-311 class=md-nav__link> <span class=md-ellipsis> Usage for Python <3.11 </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#passing-additional-args-or-kwargs class=md-nav__link> <span class=md-ellipsis> Passing additional args or kwargs </span> </a> </li> <li class=md-nav__item> <a href=#handling-no-args-or-no-kwargs class=md-nav__link> <span class=md-ellipsis> Handling no args or no kwargs </span> </a> </li> <li class=md-nav__item> <a href=#runtime-input-validation-with-types class=md-nav__link> <span class=md-ellipsis> Runtime input validation with types </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pre-defined-components class=md-nav__link> <span class=md-ellipsis> Pre-defined components </span> </a> <nav class=md-nav aria-label="Pre-defined components"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dynamic-components class=md-nav__link> <span class=md-ellipsis> Dynamic components </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#registering-components class=md-nav__link> <span class=md-ellipsis> Registering components </span> </a> <nav class=md-nav aria-label="Registering components"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-is-componentregistry class=md-nav__link> <span class=md-ellipsis> What is ComponentRegistry </span> </a> </li> <li class=md-nav__item> <a href=#working-with-componentregistry class=md-nav__link> <span class=md-ellipsis> Working with ComponentRegistry </span> </a> </li> <li class=md-nav__item> <a href=#registering-components-to-custom-componentregistry class=md-nav__link> <span class=md-ellipsis> Registering components to custom ComponentRegistry </span> </a> </li> <li class=md-nav__item> <a href=#componentregistry-settings class=md-nav__link> <span class=md-ellipsis> ComponentRegistry settings </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#autodiscovery class=md-nav__link> <span class=md-ellipsis> Autodiscovery </span> </a> <nav class=md-nav aria-label=Autodiscovery> <ul class=md-nav__list> <li class=md-nav__item> <a href=#manually-trigger-autodiscovery class=md-nav__link> <span class=md-ellipsis> Manually trigger autodiscovery </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#using-slots-in-templates class=md-nav__link> <span class=md-ellipsis> Using slots in templates </span> </a> <nav class=md-nav aria-label="Using slots in templates"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#named-slots class=md-nav__link> <span class=md-ellipsis> Named slots </span> </a> </li> <li class=md-nav__item> <a href=#default-slot class=md-nav__link> <span class=md-ellipsis> Default slot </span> </a> <nav class=md-nav aria-label="Default slot"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#accessing-default-slot-in-python class=md-nav__link> <span class=md-ellipsis> Accessing default slot in Python </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#render-fill-in-multiple-places class=md-nav__link> <span class=md-ellipsis> Render fill in multiple places </span> </a> <nav class=md-nav aria-label="Render fill in multiple places"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#default-and-required-slots class=md-nav__link> <span class=md-ellipsis> Default and required slots </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#accessing-original-content-of-slots class=md-nav__link> <span class=md-ellipsis> Accessing original content of slots </span> </a> </li> <li class=md-nav__item> <a href=#conditional-slots class=md-nav__link> <span class=md-ellipsis> Conditional slots </span> </a> <nav class=md-nav aria-label="Conditional slots"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#accessing-is_filled-of-slot-names-with-special-characters class=md-nav__link> <span class=md-ellipsis> Accessing is_filled of slot names with special characters </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#scoped-slots class=md-nav__link> <span class=md-ellipsis> Scoped slots </span> </a> <nav class=md-nav aria-label="Scoped slots"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#passing-data-to-slots class=md-nav__link> <span class=md-ellipsis> Passing data to slots </span> </a> </li> <li class=md-nav__item> <a href=#accessing-slot-data-in-fill class=md-nav__link> <span class=md-ellipsis> Accessing slot data in fill </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dynamic-slots-and-fills class=md-nav__link> <span class=md-ellipsis> Dynamic slots and fills </span> </a> </li> <li class=md-nav__item> <a href=#pass-through-all-the-slots class=md-nav__link> <span class=md-ellipsis> Pass through all the slots </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#accessing-data-passed-to-the-component class=md-nav__link> <span class=md-ellipsis> Accessing data passed to the component </span> </a> </li> <li class=md-nav__item> <a href=#rendering-html-attributes class=md-nav__link> <span class=md-ellipsis> Rendering HTML attributes </span> </a> <nav class=md-nav aria-label="Rendering HTML attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#removing-atttributes class=md-nav__link> <span class=md-ellipsis> Removing atttributes </span> </a> </li> <li class=md-nav__item> <a href=#boolean-attributes class=md-nav__link> <span class=md-ellipsis> Boolean attributes </span> </a> </li> <li class=md-nav__item> <a href=#default-attributes class=md-nav__link> <span class=md-ellipsis> Default attributes </span> </a> </li> <li class=md-nav__item> <a href=#appending-attributes class=md-nav__link> <span class=md-ellipsis> Appending attributes </span> </a> </li> <li class=md-nav__item> <a href=#rules-for-html_attrs class=md-nav__link> <span class=md-ellipsis> Rules for html_attrs </span> </a> </li> <li class=md-nav__item> <a href=#examples-for-html_attrs class=md-nav__link> <span class=md-ellipsis> Examples for html_attrs </span> </a> </li> <li class=md-nav__item> <a href=#full-example-for-html_attrs class=md-nav__link> <span class=md-ellipsis> Full example for html_attrs </span> </a> </li> <li class=md-nav__item> <a href=#rendering-html-attributes-outside-of-templates class=md-nav__link> <span class=md-ellipsis> Rendering HTML attributes outside of templates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#template-tag-syntax class=md-nav__link> <span class=md-ellipsis> Template tag syntax </span> </a> <nav class=md-nav aria-label="Template tag syntax"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#self-closing-tags class=md-nav__link> <span class=md-ellipsis> Self-closing tags </span> </a> </li> <li class=md-nav__item> <a href=#special-characters class=md-nav__link> <span class=md-ellipsis> Special characters </span> </a> </li> <li class=md-nav__item> <a href=#spread-operator class=md-nav__link> <span class=md-ellipsis> Spread operator </span> </a> </li> <li class=md-nav__item> <a href=#use-template-tags-inside-component-inputs class=md-nav__link> <span class=md-ellipsis> Use template tags inside component inputs </span> </a> <nav class=md-nav aria-label="Use template tags inside component inputs"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#passing-data-as-string-vs-original-values class=md-nav__link> <span class=md-ellipsis> Passing data as string vs original values </span> </a> </li> <li class=md-nav__item> <a href=#evaluating-python-expressions-in-template class=md-nav__link> <span class=md-ellipsis> Evaluating Python expressions in template </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pass-dictonary-by-its-key-value-pairs class=md-nav__link> <span class=md-ellipsis> Pass dictonary by its key-value pairs </span> </a> </li> <li class=md-nav__item> <a href=#multi-line-tags class=md-nav__link> <span class=md-ellipsis> Multi-line tags </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#prop-drilling-and-dependency-injection-provide-inject class=md-nav__link> <span class=md-ellipsis> Prop drilling and dependency injection (provide / inject) </span> </a> <nav class=md-nav aria-label="Prop drilling and dependency injection (provide / inject)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-is-dependency-injection-and-prop-drilling class=md-nav__link> <span class=md-ellipsis> What is "dependency injection" and "prop drilling"? </span> </a> </li> <li class=md-nav__item> <a href=#how-to-use-provide-inject class=md-nav__link> <span class=md-ellipsis> How to use provide / inject </span> </a> </li> <li class=md-nav__item> <a href=#using-provide-tag class=md-nav__link> <span class=md-ellipsis> Using {% provide %} tag </span> </a> </li> <li class=md-nav__item> <a href=#using-inject-method class=md-nav__link> <span class=md-ellipsis> Using inject() method </span> </a> </li> <li class=md-nav__item> <a href=#full-example class=md-nav__link> <span class=md-ellipsis> Full example </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#component-hooks class=md-nav__link> <span class=md-ellipsis> Component hooks </span> </a> <nav class=md-nav aria-label="Component hooks"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#available-hooks class=md-nav__link> <span class=md-ellipsis> Available hooks </span> </a> </li> <li class=md-nav__item> <a href=#component-hooks-example class=md-nav__link> <span class=md-ellipsis> Component hooks example </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#component-context-and-scope class=md-nav__link> <span class=md-ellipsis> Component context and scope </span> </a> <nav class=md-nav aria-label="Component context and scope"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#example-of-accessing-outer-context class=md-nav__link> <span class=md-ellipsis> Example of Accessing Outer Context </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pre-defined-template-variables class=md-nav__link> <span class=md-ellipsis> Pre-defined template variables </span> </a> </li> <li class=md-nav__item> <a href=#customizing-component-tags-with-tagformatter class=md-nav__link> <span class=md-ellipsis> Customizing component tags with TagFormatter </span> </a> <nav class=md-nav aria-label="Customizing component tags with TagFormatter"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#available-tagformatters class=md-nav__link> <span class=md-ellipsis> Available TagFormatters </span> </a> </li> <li class=md-nav__item> <a href=#writing-your-own-tagformatter class=md-nav__link> <span class=md-ellipsis> Writing your own TagFormatter </span> </a> <nav class=md-nav aria-label="Writing your own TagFormatter"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#background class=md-nav__link> <span class=md-ellipsis> Background </span> </a> </li> <li class=md-nav__item> <a href=#tagformatter class=md-nav__link> <span class=md-ellipsis> TagFormatter </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#defining-htmljscss-files class=md-nav__link> <span class=md-ellipsis> Defining HTML/JS/CSS files </span> </a> <nav class=md-nav aria-label="Defining HTML/JS/CSS files"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#defining-file-paths-relative-to-component-or-static-dirs class=md-nav__link> <span class=md-ellipsis> Defining file paths relative to component or static dirs </span> </a> </li> <li class=md-nav__item> <a href=#defining-multiple-paths class=md-nav__link> <span class=md-ellipsis> Defining multiple paths </span> </a> </li> <li class=md-nav__item> <a href=#configuring-css-media-types class=md-nav__link> <span class=md-ellipsis> Configuring CSS Media Types </span> </a> </li> <li class=md-nav__item> <a href=#supported-types-for-file-paths class=md-nav__link> <span class=md-ellipsis> Supported types for file paths </span> </a> </li> <li class=md-nav__item> <a href=#path-as-objects class=md-nav__link> <span class=md-ellipsis> Path as objects </span> </a> </li> <li class=md-nav__item> <a href=#customize-how-paths-are-rendered-into-html-tags-with-media_class class=md-nav__link> <span class=md-ellipsis> Customize how paths are rendered into HTML tags with media_class </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#rendering-jscss-dependencies class=md-nav__link> <span class=md-ellipsis> Rendering JS/CSS dependencies </span> </a> <nav class=md-nav aria-label="Rendering JS/CSS dependencies"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#setting-up-componentdependencymiddleware class=md-nav__link> <span class=md-ellipsis> Setting Up ComponentDependencyMiddleware </span> </a> </li> <li class=md-nav__item> <a href=#render_dependencies-and-deep-dive-into-rendering-js-css-without-the-middleware class=md-nav__link> <span class=md-ellipsis> render_dependencies and deep-dive into rendering JS / CSS without the middleware </span> </a> <nav class=md-nav aria-label="render_dependencies and deep-dive into rendering JS / CSS without the middleware"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#render-js-css-without-the-middleware class=md-nav__link> <span class=md-ellipsis> Render JS / CSS without the middleware </span> </a> </li> <li class=md-nav__item> <a href=#inserting-pre-rendered-html-into-another-component class=md-nav__link> <span class=md-ellipsis> Inserting pre-rendered HTML into another component </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#available-settings class=md-nav__link> <span class=md-ellipsis> Available settings </span> </a> <nav class=md-nav aria-label="Available settings"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#libraries-load-component-modules class=md-nav__link> <span class=md-ellipsis> libraries - Load component modules </span> </a> </li> <li class=md-nav__item> <a href=#autodiscover-toggle-autodiscovery class=md-nav__link> <span class=md-ellipsis> autodiscover - Toggle autodiscovery </span> </a> </li> <li class=md-nav__item> <a href=#dirs class=md-nav__link> <span class=md-ellipsis> dirs </span> </a> </li> <li class=md-nav__item> <a href=#app_dirs class=md-nav__link> <span class=md-ellipsis> app_dirs </span> </a> </li> <li class=md-nav__item> <a href=#dynamic_component_name class=md-nav__link> <span class=md-ellipsis> dynamic_component_name </span> </a> </li> <li class=md-nav__item> <a href=#multiline_tags-enabledisable-multiline-support class=md-nav__link> <span class=md-ellipsis> multiline_tags - Enable/Disable multiline support </span> </a> </li> <li class=md-nav__item> <a href=#static_files_allowed class=md-nav__link> <span class=md-ellipsis> static_files_allowed </span> </a> </li> <li class=md-nav__item> <a href=#static_files_forbidden class=md-nav__link> <span class=md-ellipsis> static_files_forbidden </span> </a> </li> <li class=md-nav__item> <a href=#template_cache_size-tune-the-template-cache class=md-nav__link> <span class=md-ellipsis> template_cache_size - Tune the template cache </span> </a> </li> <li class=md-nav__item> <a href=#context_behavior-make-components-isolated-or-not class=md-nav__link> <span class=md-ellipsis> context_behavior - Make components isolated (or not) </span> </a> <nav class=md-nav aria-label="context_behavior - Make components isolated (or not)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#example-django class=md-nav__link> <span class=md-ellipsis> Example "django" </span> </a> </li> <li class=md-nav__item> <a href=#example-isolated class=md-nav__link> <span class=md-ellipsis> Example "isolated" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#reload_on_template_change-reload-dev-server-on-component-file-changes class=md-nav__link> <span class=md-ellipsis> reload_on_template_change - Reload dev server on component file changes </span> </a> </li> <li class=md-nav__item> <a href=#tag_formatter-change-how-components-are-used-in-templates class=md-nav__link> <span class=md-ellipsis> tag_formatter - Change how components are used in templates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#running-with-development-server class=md-nav__link> <span class=md-ellipsis> Running with development server </span> </a> <nav class=md-nav aria-label="Running with development server"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#reload-dev-server-on-component-file-changes class=md-nav__link> <span class=md-ellipsis> Reload dev server on component file changes </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#logging-and-debugging class=md-nav__link> <span class=md-ellipsis> Logging and debugging </span> </a> </li> <li class=md-nav__item> <a href=#management-command class=md-nav__link> <span class=md-ellipsis> Management Command </span> </a> <nav class=md-nav aria-label="Management Command"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#management-command-usage class=md-nav__link> <span class=md-ellipsis> Management Command Usage </span> </a> </li> <li class=md-nav__item> <a href=#management-command-examples class=md-nav__link> <span class=md-ellipsis> Management Command Examples </span> </a> </li> <li class=md-nav__item> <a href=#creating-a-component-with-default-settings class=md-nav__link> <span class=md-ellipsis> Creating a Component with Default Settings </span> </a> </li> <li class=md-nav__item> <a href=#creating-a-component-with-custom-settings class=md-nav__link> <span class=md-ellipsis> Creating a Component with Custom Settings </span> </a> </li> <li class=md-nav__item> <a href=#overwriting-an-existing-component class=md-nav__link> <span class=md-ellipsis> Overwriting an Existing Component </span> </a> </li> <li class=md-nav__item> <a href=#simulating-component-creation class=md-nav__link> <span class=md-ellipsis> Simulating Component Creation </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#writing-and-sharing-component-libraries class=md-nav__link> <span class=md-ellipsis> Writing and sharing component libraries </span> </a> <nav class=md-nav aria-label="Writing and sharing component libraries"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#writing-component-libraries class=md-nav__link> <span class=md-ellipsis> Writing component libraries </span> </a> </li> <li class=md-nav__item> <a href=#publishing-component-libraries class=md-nav__link> <span class=md-ellipsis> Publishing component libraries </span> </a> </li> <li class=md-nav__item> <a href=#installing-and-using-component-libraries class=md-nav__link> <span class=md-ellipsis> Installing and using component libraries </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#community-examples class=md-nav__link> <span class=md-ellipsis> Community examples </span> </a> </li> <li class=md-nav__item> <a href=#contributing-and-development class=md-nav__link> <span class=md-ellipsis> Contributing and development </span> </a> <nav class=md-nav aria-label="Contributing and development"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#install-locally-and-run-the-tests class=md-nav__link> <span class=md-ellipsis> Install locally and run the tests </span> </a> </li> <li class=md-nav__item> <a href=#running-playwright-tests class=md-nav__link> <span class=md-ellipsis> Running Playwright tests </span> </a> </li> <li class=md-nav__item> <a href=#developing-against-live-django-app class=md-nav__link> <span class=md-ellipsis> Developing against live Django app </span> </a> </li> <li class=md-nav__item> <a href=#building-js-code class=md-nav__link> <span class=md-ellipsis> Building JS code </span> </a> </li> <li class=md-nav__item> <a href=#packaging-and-publishing class=md-nav__link> <span class=md-ellipsis> Packaging and publishing </span> </a> </li> <li class=md-nav__item> <a href=#development-guides class=md-nav__link> <span class=md-ellipsis> Development guides </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <a href=https://github.com/EmilStenstrom/django-components/edit/master/src/docs/README.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <a href=https://github.com/EmilStenstrom/django-components/raw/master/src/docs/README.md title="View source of this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1 id=_1><img src=https://raw.githubusercontent.com/EmilStenstrom/django-components/master/logo/logo-black-on-white.svg alt=django-components style="max-width: 100%; background: white; color: black;"><a class=headerlink href=#_1 title="Permanent link">¤</a></h1> <p><a href=https://pypi.org/project/django-components/ ><img alt="PyPI - Version" src=https://img.shields.io/pypi/v/django-components></a> <a href=https://pypi.org/project/django-components/ ><img alt="PyPI - Python Version" src=https://img.shields.io/pypi/pyversions/django-components></a> <a href=https://EmilStenstrom.github.io/django-components/latest/license/ ><img alt="PyPI - License" src=https://img.shields.io/pypi/l/django-components></a> <a href=https://pypistats.org/packages/django-components><img alt="PyPI - Downloads" src=https://img.shields.io/pypi/dm/django-components></a> <a href=https://github.com/EmilStenstrom/django-components/actions/workflows/tests.yml><img alt="GitHub Actions Workflow Status" src=https://img.shields.io/github/actions/workflow/status/EmilStenstrom/django-components/tests.yml></a></p> <p><a href=https://EmilStenstrom.github.io/django-components/latest/ ><strong>Docs (Work in progress)</strong></a></p> <p>Django-components is a package that introduces component-based architecture to Django's server-side rendering. It aims to combine Django's templating system with the modularity seen in modern frontend frameworks.</p> <h2 id=features>Features<a class=headerlink href=#features title="Permanent link">¤</a></h2> <ol> <li>🧩 <strong>Reusability:</strong> Allows creation of self-contained, reusable UI elements.</li> <li>📦 <strong>Encapsulation:</strong> Each component can include its own HTML, CSS, and JavaScript.</li> <li>🚀 <strong>Server-side rendering:</strong> Components render on the server, improving initial load times and SEO.</li> <li>🐍 <strong>Django integration:</strong> Works within the Django ecosystem, using familiar concepts like template tags.</li> <li>⚡ <strong>Asynchronous loading:</strong> Components can render independently opening up for integration with JS frameworks like HTMX or AlpineJS.</li> </ol> <p>Potential benefits:</p> <ul> <li>🔄 Reduced code duplication</li> <li>🛠️ Improved maintainability through modular design</li> <li>🧠 Easier management of complex UIs</li> <li>🤝 Enhanced collaboration between frontend and backend developers</li> </ul> <p>Django-components can be particularly useful for larger Django projects that require a more structured approach to UI development, without necessitating a shift to a separate frontend framework.</p> <h2 id=quickstart>Quickstart<a class=headerlink href=#quickstart title="Permanent link">¤</a></h2> <p>django-components lets you create reusable blocks of code needed to generate the front end code you need for a modern app. </p> <p>Define a component in <code>components/calendar/calendar.py</code> like this: <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"template.html"</span>
|
||
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a>
|
||
<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>):</span>
|
||
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> <span class=k>return</span> <span class=p>{</span><span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>}</span>
|
||
</code></pre></div></p> <p>With this <code>template.html</code> file:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Use the component like this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2024-11-06"</span> <span class=cp>%}{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>And this is what gets rendered:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span>2024-11-06<span class=p></</span><span class=nt>span</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Read on to learn about all the exciting details and configuration possibilities!</p> <p>(If you instead prefer to jump right into the code, <a href=https://github.com/EmilStenstrom/django-components/tree/master/sampleproject>check out the example project</a>)</p> <h2 id=table-of-contents>Table of Contents<a class=headerlink href=#table-of-contents title="Permanent link">¤</a></h2> <ul> <li><a href=#release-notes>Release notes</a></li> <li><a href=#security-notes->Security notes 🚨</a></li> <li><a href=#installation>Installation</a></li> <li><a href=#compatibility>Compatibility</a></li> <li><a href=#create-your-first-component>Create your first component</a></li> <li><a href=#using-single-file-components>Using single-file components</a></li> <li><a href=#use-components-in-templates>Use components in templates</a></li> <li><a href=#use-components-outside-of-templates>Use components outside of templates</a></li> <li><a href=#use-components-as-views>Use components as views</a></li> <li><a href=#typing-and-validating-components>Typing and validating components</a></li> <li><a href=#pre-defined-components>Pre-defined components</a></li> <li><a href=#registering-components>Registering components</a></li> <li><a href=#autodiscovery>Autodiscovery</a></li> <li><a href=#using-slots-in-templates>Using slots in templates</a></li> <li><a href=#accessing-data-passed-to-the-component>Accessing data passed to the component</a></li> <li><a href=#rendering-html-attributes>Rendering HTML attributes</a></li> <li><a href=#template-tag-syntax>Template tag syntax</a></li> <li><a href=#prop-drilling-and-dependency-injection-provide--inject>Prop drilling and dependency injection (provide / inject)</a></li> <li><a href=#component-hooks>Component hooks</a></li> <li><a href=#component-context-and-scope>Component context and scope</a></li> <li><a href=#pre-defined-template-variables>Pre-defined template variables</a></li> <li><a href=#customizing-component-tags-with-tagformatter>Customizing component tags with TagFormatter</a></li> <li><a href=#defining-htmljscss-files>Defining HTML/JS/CSS files</a></li> <li><a href=#rendering-jscss-dependencies>Rendering JS/CSS dependencies</a></li> <li><a href=#available-settings>Available settings</a></li> <li><a href=#running-with-development-server>Running with development server</a></li> <li><a href=#logging-and-debugging>Logging and debugging</a></li> <li><a href=#management-command>Management Command</a></li> <li><a href=#writing-and-sharing-component-libraries>Writing and sharing component libraries</a></li> <li><a href=#community-examples>Community examples</a></li> <li><a href=#running-django-components-project-locally>Running django-components project locally</a></li> <li><a href=#development-guides>Development guides</a></li> </ul> <h2 id=release-notes>Release notes<a class=headerlink href=#release-notes title="Permanent link">¤</a></h2> <p>Read the <a href=https://github.com/EmilStenstrom/django-components/tree/master/CHANGELOG.md>Release Notes</a> to see the latest features and fixes.</p> <h2 id=security-notes>Security notes 🚨<a class=headerlink href=#security-notes title="Permanent link">¤</a></h2> <p><em>It is strongly recommended to read this section before using django-components in production.</em></p> <h3 id=static-files>Static files<a class=headerlink href=#static-files title="Permanent link">¤</a></h3> <p>Components can be organized however you prefer. That said, our prefered way is to keep the files of a component close together by bundling them in the same directory.</p> <p>This means that files containing backend logic, such as Python modules and HTML templates, live in the same directory as static files, e.g. JS and CSS.</p> <p>From v0.100 onwards, we keep component files (as defined by <a href=#dirs><code>COMPONENTS.dirs</code></a> and <a href=#app_dirs><code>COMPONENTS.app_dirs</code></a>) separate from the rest of the static files (defined by <code>STATICFILES_DIRS</code>). That way, the Python and HTML files are NOT exposed by the server. Only the static JS, CSS, and <a href=#static_files_allowed>other common formats</a>.</p> <blockquote> <p>NOTE: If you need to expose different file formats, you can configure these with <a href=#static_files_allowed><code>COMPONENTS.static_files_allowed</code></a> and <a href=#static_files_forbidden><code>COMPONENTS.static_files_forbidden</code></a>.</p> </blockquote> <!-- # TODO_REMOVE_IN_V1 - Remove mentions of safer_staticfiles in V1 --> <h4 id=static-files-prior-to-v0100>Static files prior to v0.100<a class=headerlink href=#static-files-prior-to-v0100 title="Permanent link">¤</a></h4> <p>Prior to v0.100, if your were using <em>django.contrib.staticfiles</em> to collect static files, no distinction was made between the different kinds of files.</p> <p>As a result, your Python code and templates may inadvertently become available on your static file server. You probably don't want this, as parts of your backend logic will be exposed, posing a <strong>potential security vulnerability</strong>.</p> <p>From <em>v0.27</em> until <em>v0.100</em>, django-components shipped with an additional installable app <em>django_components.<strong>safer_staticfiles</strong></em>. It was a drop-in replacement for <em>django.contrib.staticfiles</em>. Its behavior is 100% identical except it ignores .py and .html files, meaning these will not end up on your static files server. To use it, add it to INSTALLED_APPS and remove <em>django.contrib.staticfiles</em>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=n>INSTALLED_APPS</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a> <span class=c1># 'django.contrib.staticfiles', # <-- REMOVE</span>
|
||
<a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a> <span class=s1>'django_components'</span><span class=p>,</span>
|
||
<a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a> <span class=s1>'django_components.safer_staticfiles'</span> <span class=c1># <-- ADD</span>
|
||
<a id=__codelineno-4-5 name=__codelineno-4-5 href=#__codelineno-4-5></a><span class=p>]</span>
|
||
</code></pre></div> <p>If you are on an older version of django-components, your alternatives are a) passing <code>--ignore <pattern></code> options to the <em>collecstatic</em> CLI command, or b) defining a subclass of StaticFilesConfig. Both routes are described in the official <a href=https://docs.djangoproject.com/en/4.2/ref/contrib/staticfiles/#customizing-the-ignored-pattern-list>docs of the <em>staticfiles</em> app</a>.</p> <p>Note that <code>safer_staticfiles</code> excludes the <code>.py</code> and <code>.html</code> files for <a href=https://docs.djangoproject.com/en/5.0/ref/contrib/staticfiles/#collectstatic>collectstatic command</a>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a>python<span class=w> </span>manage.py<span class=w> </span>collectstatic
|
||
</code></pre></div> <p>but it is ignored on the <a href=https://docs.djangoproject.com/en/5.0/ref/django-admin/#runserver>development server</a>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a>python<span class=w> </span>manage.py<span class=w> </span>runserver
|
||
</code></pre></div> <p>For a step-by-step guide on deploying production server with static files, <a href=https://github.com/EmilStenstrom/django-components/tree/master/sampleproject>see the demo project</a>.</p> <h2 id=installation>Installation<a class=headerlink href=#installation title="Permanent link">¤</a></h2> <ol> <li>Install <code>django_components</code> into your environment:</li> </ol> <blockquote> <p><code>pip install django_components</code></p> </blockquote> <ol> <li>Load <code>django_components</code> into Django by adding it into <code>INSTALLED_APPS</code> in settings.py:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a><span class=n>INSTALLED_APPS</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-7-2 name=__codelineno-7-2 href=#__codelineno-7-2></a> <span class=o>...</span><span class=p>,</span>
|
||
<a id=__codelineno-7-3 name=__codelineno-7-3 href=#__codelineno-7-3></a> <span class=s1>'django_components'</span><span class=p>,</span>
|
||
<a id=__codelineno-7-4 name=__codelineno-7-4 href=#__codelineno-7-4></a><span class=p>]</span>
|
||
</code></pre></div> <ol> <li><code>BASE_DIR</code> setting is required. Ensure that it is defined in settings.py:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=n>BASE_DIR</span> <span class=o>=</span> <span class=n>Path</span><span class=p>(</span><span class=vm>__file__</span><span class=p>)</span><span class=o>.</span><span class=n>resolve</span><span class=p>()</span><span class=o>.</span><span class=n>parent</span><span class=o>.</span><span class=n>parent</span>
|
||
</code></pre></div> <ol> <li>Add / modify <a href=#dirs><code>COMPONENTS.dirs</code></a> and / or <a href=#app_dirs><code>COMPONENTS.app_dirs</code></a> so django_components knows where to find component HTML, JS and CSS files:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-9-1 name=__codelineno-9-1 href=#__codelineno-9-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-9-2 name=__codelineno-9-2 href=#__codelineno-9-2></a> <span class=s2>"dirs"</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-9-3 name=__codelineno-9-3 href=#__codelineno-9-3></a> <span class=o>...</span><span class=p>,</span>
|
||
<a id=__codelineno-9-4 name=__codelineno-9-4 href=#__codelineno-9-4></a> <span class=n>os</span><span class=o>.</span><span class=n>path</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>BASE_DIR</span><span class=p>,</span> <span class=s2>"components"</span><span class=p>),</span>
|
||
<a id=__codelineno-9-5 name=__codelineno-9-5 href=#__codelineno-9-5></a> <span class=p>],</span>
|
||
<a id=__codelineno-9-6 name=__codelineno-9-6 href=#__codelineno-9-6></a><span class=p>}</span>
|
||
</code></pre></div> <p>If <code>COMPONENTS.dirs</code> is omitted, django-components will by default look for a top-level <code>/components</code> directory, <code>{BASE_DIR}/components</code>.</p> <p>In addition to <code>COMPONENTS.dirs</code>, django_components will also load components from app-level directories, such as <code>my-app/components/</code>. The directories within apps are configured with <a href=#app_dirs><code>COMPONENTS.app_dirs</code></a>, and the default is <code>[app]/components</code>.</p> <p>NOTE: The input to <code>COMPONENTS.dirs</code> is the same as for <code>STATICFILES_DIRS</code>, and the paths must be full paths. <a href=https://docs.djangoproject.com/en/5.0/ref/settings/#staticfiles-dirs>See Django docs</a>.</p> <ol> <li> <p>Next, to make Django load component HTML files as Django templates, modify <code>TEMPLATES</code> section of settings.py as follows:</p> </li> <li> <p><em>Remove <code>'APP_DIRS': True,</code></em></p> <ul> <li>NOTE: Instead of APP_DIRS, for the same effect, we will use <a href=https://docs.djangoproject.com/en/5.1/ref/templates/api/#django.template.loaders.app_directories.Loader><code>django.template.loaders.app_directories.Loader</code></a></li> </ul> </li> <li>Add <code>loaders</code> to <code>OPTIONS</code> list and set it to following value:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a><span class=n>TEMPLATES</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-10-2 name=__codelineno-10-2 href=#__codelineno-10-2></a> <span class=p>{</span>
|
||
<a id=__codelineno-10-3 name=__codelineno-10-3 href=#__codelineno-10-3></a> <span class=o>...</span><span class=p>,</span>
|
||
<a id=__codelineno-10-4 name=__codelineno-10-4 href=#__codelineno-10-4></a> <span class=s1>'OPTIONS'</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-10-5 name=__codelineno-10-5 href=#__codelineno-10-5></a> <span class=s1>'context_processors'</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-10-6 name=__codelineno-10-6 href=#__codelineno-10-6></a> <span class=o>...</span>
|
||
<a id=__codelineno-10-7 name=__codelineno-10-7 href=#__codelineno-10-7></a> <span class=p>],</span>
|
||
<a id=__codelineno-10-8 name=__codelineno-10-8 href=#__codelineno-10-8></a> <span class=s1>'loaders'</span><span class=p>:[(</span>
|
||
<a id=__codelineno-10-9 name=__codelineno-10-9 href=#__codelineno-10-9></a> <span class=s1>'django.template.loaders.cached.Loader'</span><span class=p>,</span> <span class=p>[</span>
|
||
<a id=__codelineno-10-10 name=__codelineno-10-10 href=#__codelineno-10-10></a> <span class=c1># Default Django loader</span>
|
||
<a id=__codelineno-10-11 name=__codelineno-10-11 href=#__codelineno-10-11></a> <span class=s1>'django.template.loaders.filesystem.Loader'</span><span class=p>,</span>
|
||
<a id=__codelineno-10-12 name=__codelineno-10-12 href=#__codelineno-10-12></a> <span class=c1># Inluding this is the same as APP_DIRS=True</span>
|
||
<a id=__codelineno-10-13 name=__codelineno-10-13 href=#__codelineno-10-13></a> <span class=s1>'django.template.loaders.app_directories.Loader'</span><span class=p>,</span>
|
||
<a id=__codelineno-10-14 name=__codelineno-10-14 href=#__codelineno-10-14></a> <span class=c1># Components loader</span>
|
||
<a id=__codelineno-10-15 name=__codelineno-10-15 href=#__codelineno-10-15></a> <span class=s1>'django_components.template_loader.Loader'</span><span class=p>,</span>
|
||
<a id=__codelineno-10-16 name=__codelineno-10-16 href=#__codelineno-10-16></a> <span class=p>]</span>
|
||
<a id=__codelineno-10-17 name=__codelineno-10-17 href=#__codelineno-10-17></a> <span class=p>)],</span>
|
||
<a id=__codelineno-10-18 name=__codelineno-10-18 href=#__codelineno-10-18></a> <span class=p>},</span>
|
||
<a id=__codelineno-10-19 name=__codelineno-10-19 href=#__codelineno-10-19></a> <span class=p>},</span>
|
||
<a id=__codelineno-10-20 name=__codelineno-10-20 href=#__codelineno-10-20></a><span class=p>]</span>
|
||
</code></pre></div> <ol> <li>Lastly, be able to serve the component JS and CSS files as static files, modify <code>STATICFILES_FINDERS</code> section of settings.py as follows:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=n>STATICFILES_FINDERS</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-2></a> <span class=c1># Default finders</span>
|
||
<a id=__codelineno-11-3 name=__codelineno-11-3 href=#__codelineno-11-3></a> <span class=s2>"django.contrib.staticfiles.finders.FileSystemFinder"</span><span class=p>,</span>
|
||
<a id=__codelineno-11-4 name=__codelineno-11-4 href=#__codelineno-11-4></a> <span class=s2>"django.contrib.staticfiles.finders.AppDirectoriesFinder"</span><span class=p>,</span>
|
||
<a id=__codelineno-11-5 name=__codelineno-11-5 href=#__codelineno-11-5></a> <span class=c1># Django components</span>
|
||
<a id=__codelineno-11-6 name=__codelineno-11-6 href=#__codelineno-11-6></a> <span class=s2>"django_components.finders.ComponentsFileSystemFinder"</span><span class=p>,</span>
|
||
<a id=__codelineno-11-7 name=__codelineno-11-7 href=#__codelineno-11-7></a><span class=p>]</span>
|
||
</code></pre></div> <h3 id=adding-support-for-js-and-css>Adding support for JS and CSS<a class=headerlink href=#adding-support-for-js-and-css title="Permanent link">¤</a></h3> <p>If you want to use JS or CSS with components, you will need to:</p> <ol> <li>Add <a href=#setting-up-componentdependencymiddleware><code>ComponentDependencyMiddleware</code></a> to <code>MIDDLEWARE</code> setting.</li> </ol> <p>The middleware searches the outgoing HTML for all components that were rendered to generate the HTML, and adds the JS and CSS associated with those components.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a><span class=n>MIDDLEWARE</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-12-2 name=__codelineno-12-2 href=#__codelineno-12-2></a> <span class=o>...</span>
|
||
<a id=__codelineno-12-3 name=__codelineno-12-3 href=#__codelineno-12-3></a> <span class=s2>"django_components.middleware.ComponentDependencyMiddleware"</span><span class=p>,</span>
|
||
<a id=__codelineno-12-4 name=__codelineno-12-4 href=#__codelineno-12-4></a><span class=p>]</span>
|
||
</code></pre></div> <p>Read more in <a href=#rendering-jscss-dependencies>Rendering JS/CSS dependencies</a>.</p> <ol> <li>Add django-component's URL paths to your <code>urlpatterns</code>:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=kn>from</span> <span class=nn>django.urls</span> <span class=kn>import</span> <span class=n>include</span><span class=p>,</span> <span class=n>path</span>
|
||
<a id=__codelineno-13-2 name=__codelineno-13-2 href=#__codelineno-13-2></a>
|
||
<a id=__codelineno-13-3 name=__codelineno-13-3 href=#__codelineno-13-3></a><span class=n>urlpatterns</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-13-4 name=__codelineno-13-4 href=#__codelineno-13-4></a> <span class=o>...</span>
|
||
<a id=__codelineno-13-5 name=__codelineno-13-5 href=#__codelineno-13-5></a> <span class=n>path</span><span class=p>(</span><span class=s2>""</span><span class=p>,</span> <span class=n>include</span><span class=p>(</span><span class=s2>"django_components.urls"</span><span class=p>)),</span>
|
||
<a id=__codelineno-13-6 name=__codelineno-13-6 href=#__codelineno-13-6></a><span class=p>]</span>
|
||
</code></pre></div> <h3 id=optional>Optional<a class=headerlink href=#optional title="Permanent link">¤</a></h3> <p>To avoid loading the app in each template using <code>{% load component_tags %}</code>, you can add the tag as a 'builtin' in settings.py</p> <div class=highlight><pre><span></span><code><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a><span class=n>TEMPLATES</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-14-2 name=__codelineno-14-2 href=#__codelineno-14-2></a> <span class=p>{</span>
|
||
<a id=__codelineno-14-3 name=__codelineno-14-3 href=#__codelineno-14-3></a> <span class=o>...</span><span class=p>,</span>
|
||
<a id=__codelineno-14-4 name=__codelineno-14-4 href=#__codelineno-14-4></a> <span class=s1>'OPTIONS'</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-14-5 name=__codelineno-14-5 href=#__codelineno-14-5></a> <span class=s1>'context_processors'</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-14-6 name=__codelineno-14-6 href=#__codelineno-14-6></a> <span class=o>...</span>
|
||
<a id=__codelineno-14-7 name=__codelineno-14-7 href=#__codelineno-14-7></a> <span class=p>],</span>
|
||
<a id=__codelineno-14-8 name=__codelineno-14-8 href=#__codelineno-14-8></a> <span class=s1>'builtins'</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-14-9 name=__codelineno-14-9 href=#__codelineno-14-9></a> <span class=s1>'django_components.templatetags.component_tags'</span><span class=p>,</span>
|
||
<a id=__codelineno-14-10 name=__codelineno-14-10 href=#__codelineno-14-10></a> <span class=p>]</span>
|
||
<a id=__codelineno-14-11 name=__codelineno-14-11 href=#__codelineno-14-11></a> <span class=p>},</span>
|
||
<a id=__codelineno-14-12 name=__codelineno-14-12 href=#__codelineno-14-12></a> <span class=p>},</span>
|
||
<a id=__codelineno-14-13 name=__codelineno-14-13 href=#__codelineno-14-13></a><span class=p>]</span>
|
||
</code></pre></div> <p>Read on to find out how to build your first component!</p> <h2 id=compatibility>Compatibility<a class=headerlink href=#compatibility title="Permanent link">¤</a></h2> <p>Django-components supports all supported combinations versions of <a href=https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django>Django</a> and <a href=https://devguide.python.org/versions/#versions>Python</a>.</p> <table> <thead> <tr> <th>Python version</th> <th>Django version</th> </tr> </thead> <tbody> <tr> <td>3.8</td> <td>4.2</td> </tr> <tr> <td>3.9</td> <td>4.2</td> </tr> <tr> <td>3.10</td> <td>4.2, 5.0</td> </tr> <tr> <td>3.11</td> <td>4.2, 5.0</td> </tr> <tr> <td>3.12</td> <td>4.2, 5.0</td> </tr> </tbody> </table> <h2 id=create-your-first-component>Create your first component<a class=headerlink href=#create-your-first-component title="Permanent link">¤</a></h2> <p>A component in django-components is the combination of four things: CSS, Javascript, a Django template, and some Python code to put them all together.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a> sampleproject/
|
||
<a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a> ├── calendarapp/
|
||
<a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a> ├── components/ 🆕
|
||
<a id=__codelineno-15-4 name=__codelineno-15-4 href=#__codelineno-15-4></a> │ └── calendar/ 🆕
|
||
<a id=__codelineno-15-5 name=__codelineno-15-5 href=#__codelineno-15-5></a> │ ├── calendar.py 🆕
|
||
<a id=__codelineno-15-6 name=__codelineno-15-6 href=#__codelineno-15-6></a> │ ├── script.js 🆕
|
||
<a id=__codelineno-15-7 name=__codelineno-15-7 href=#__codelineno-15-7></a> │ ├── style.css 🆕
|
||
<a id=__codelineno-15-8 name=__codelineno-15-8 href=#__codelineno-15-8></a> │ └── template.html 🆕
|
||
<a id=__codelineno-15-9 name=__codelineno-15-9 href=#__codelineno-15-9></a> ├── sampleproject/
|
||
<a id=__codelineno-15-10 name=__codelineno-15-10 href=#__codelineno-15-10></a> ├── manage.py
|
||
<a id=__codelineno-15-11 name=__codelineno-15-11 href=#__codelineno-15-11></a> └── requirements.txt
|
||
</code></pre></div> <p>Start by creating empty files in the structure above.</p> <p>First, you need a CSS file. Be sure to prefix all rules with a unique class so they don't clash with other rules.</p> <div class=highlight><span class=filename>[project root]/components/calendar/style.css</span><pre><span></span><code><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=c>/* In a file called [project root]/components/calendar/style.css */</span>
|
||
<a id=__codelineno-16-2 name=__codelineno-16-2 href=#__codelineno-16-2></a><span class=p>.</span><span class=nc>calendar-component</span><span class=w> </span><span class=p>{</span>
|
||
<a id=__codelineno-16-3 name=__codelineno-16-3 href=#__codelineno-16-3></a><span class=w> </span><span class=k>width</span><span class=p>:</span><span class=w> </span><span class=mi>200</span><span class=kt>px</span><span class=p>;</span>
|
||
<a id=__codelineno-16-4 name=__codelineno-16-4 href=#__codelineno-16-4></a><span class=w> </span><span class=k>background</span><span class=p>:</span><span class=w> </span><span class=kc>pink</span><span class=p>;</span>
|
||
<a id=__codelineno-16-5 name=__codelineno-16-5 href=#__codelineno-16-5></a><span class=p>}</span>
|
||
<a id=__codelineno-16-6 name=__codelineno-16-6 href=#__codelineno-16-6></a><span class=p>.</span><span class=nc>calendar-component</span><span class=w> </span><span class=nt>span</span><span class=w> </span><span class=p>{</span>
|
||
<a id=__codelineno-16-7 name=__codelineno-16-7 href=#__codelineno-16-7></a><span class=w> </span><span class=k>font-weight</span><span class=p>:</span><span class=w> </span><span class=kc>bold</span><span class=p>;</span>
|
||
<a id=__codelineno-16-8 name=__codelineno-16-8 href=#__codelineno-16-8></a><span class=p>}</span>
|
||
</code></pre></div> <p>Then you need a javascript file that specifies how you interact with this component. You are free to use any javascript framework you want. A good way to make sure this component doesn't clash with other components is to define all code inside an anonymous function that calls itself. This makes all variables defined only be defined inside this component and not affect other components.</p> <div class=highlight><span class=filename>[project root]/components/calendar/script.js</span><pre><span></span><code><a id=__codelineno-17-1 name=__codelineno-17-1 href=#__codelineno-17-1></a><span class=cm>/* In a file called [project root]/components/calendar/script.js */</span>
|
||
<a id=__codelineno-17-2 name=__codelineno-17-2 href=#__codelineno-17-2></a><span class=p>(</span><span class=kd>function</span><span class=w> </span><span class=p>()</span><span class=w> </span><span class=p>{</span>
|
||
<a id=__codelineno-17-3 name=__codelineno-17-3 href=#__codelineno-17-3></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=nb>document</span><span class=p>.</span><span class=nx>querySelector</span><span class=p>(</span><span class=s2>".calendar-component"</span><span class=p>))</span><span class=w> </span><span class=p>{</span>
|
||
<a id=__codelineno-17-4 name=__codelineno-17-4 href=#__codelineno-17-4></a><span class=w> </span><span class=nb>document</span><span class=p>.</span><span class=nx>querySelector</span><span class=p>(</span><span class=s2>".calendar-component"</span><span class=p>).</span><span class=nx>onclick</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kd>function</span><span class=w> </span><span class=p>()</span><span class=w> </span><span class=p>{</span>
|
||
<a id=__codelineno-17-5 name=__codelineno-17-5 href=#__codelineno-17-5></a><span class=w> </span><span class=nx>alert</span><span class=p>(</span><span class=s2>"Clicked calendar!"</span><span class=p>);</span>
|
||
<a id=__codelineno-17-6 name=__codelineno-17-6 href=#__codelineno-17-6></a><span class=w> </span><span class=p>};</span>
|
||
<a id=__codelineno-17-7 name=__codelineno-17-7 href=#__codelineno-17-7></a><span class=w> </span><span class=p>}</span>
|
||
<a id=__codelineno-17-8 name=__codelineno-17-8 href=#__codelineno-17-8></a><span class=p>})();</span>
|
||
</code></pre></div> <p>Now you need a Django template for your component. Feel free to define more variables like <code>date</code> in this example. When creating an instance of this component we will send in the values for these variables. The template will be rendered with whatever template backend you've specified in your Django settings file.</p> <div class=highlight><span class=filename>[project root]/components/calendar/calendar.html</span><pre><span></span><code><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=c>{# In a file called [project root]/components/calendar/template.html #}</span>
|
||
<a id=__codelineno-18-2 name=__codelineno-18-2 href=#__codelineno-18-2></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Finally, we use django-components to tie this together. Start by creating a file called <code>calendar.py</code> in your component calendar directory. It will be auto-detected and loaded by the app.</p> <p>Inside this file we create a Component by inheriting from the Component class and specifying the context method. We also register the global component registry so that we easily can render it anywhere in our templates.</p> <div class=highlight><span class=filename>[project root]/components/calendar/calendar.py</span><pre><span></span><code><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-1></a><span class=c1># In a file called [project root]/components/calendar/calendar.py</span>
|
||
<a id=__codelineno-19-2 name=__codelineno-19-2 href=#__codelineno-19-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-19-3 name=__codelineno-19-3 href=#__codelineno-19-3></a>
|
||
<a id=__codelineno-19-4 name=__codelineno-19-4 href=#__codelineno-19-4></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-19-5 name=__codelineno-19-5 href=#__codelineno-19-5></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-19-6 name=__codelineno-19-6 href=#__codelineno-19-6></a> <span class=c1># Templates inside `[your apps]/components` dir and `[project root]/components` dir</span>
|
||
<a id=__codelineno-19-7 name=__codelineno-19-7 href=#__codelineno-19-7></a> <span class=c1># will be automatically found.</span>
|
||
<a id=__codelineno-19-8 name=__codelineno-19-8 href=#__codelineno-19-8></a> <span class=c1>#</span>
|
||
<a id=__codelineno-19-9 name=__codelineno-19-9 href=#__codelineno-19-9></a> <span class=c1># `template_name` can be relative to dir where `calendar.py` is, or relative to COMPONENTS.dirs</span>
|
||
<a id=__codelineno-19-10 name=__codelineno-19-10 href=#__codelineno-19-10></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"template.html"</span>
|
||
<a id=__codelineno-19-11 name=__codelineno-19-11 href=#__codelineno-19-11></a> <span class=c1># Or</span>
|
||
<a id=__codelineno-19-12 name=__codelineno-19-12 href=#__codelineno-19-12></a> <span class=k>def</span> <span class=nf>get_template_name</span><span class=p>(</span><span class=n>context</span><span class=p>):</span>
|
||
<a id=__codelineno-19-13 name=__codelineno-19-13 href=#__codelineno-19-13></a> <span class=k>return</span> <span class=sa>f</span><span class=s2>"template-</span><span class=si>{</span><span class=n>context</span><span class=p>[</span><span class=s1>'name'</span><span class=p>]</span><span class=si>}</span><span class=s2>.html"</span>
|
||
<a id=__codelineno-19-14 name=__codelineno-19-14 href=#__codelineno-19-14></a>
|
||
<a id=__codelineno-19-15 name=__codelineno-19-15 href=#__codelineno-19-15></a> <span class=c1># This component takes one parameter, a date string to show in the template</span>
|
||
<a id=__codelineno-19-16 name=__codelineno-19-16 href=#__codelineno-19-16></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>):</span>
|
||
<a id=__codelineno-19-17 name=__codelineno-19-17 href=#__codelineno-19-17></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-19-18 name=__codelineno-19-18 href=#__codelineno-19-18></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
||
<a id=__codelineno-19-19 name=__codelineno-19-19 href=#__codelineno-19-19></a> <span class=p>}</span>
|
||
<a id=__codelineno-19-20 name=__codelineno-19-20 href=#__codelineno-19-20></a>
|
||
<a id=__codelineno-19-21 name=__codelineno-19-21 href=#__codelineno-19-21></a> <span class=c1># Both `css` and `js` can be relative to dir where `calendar.py` is, or relative to COMPONENTS.dirs</span>
|
||
<a id=__codelineno-19-22 name=__codelineno-19-22 href=#__codelineno-19-22></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-19-23 name=__codelineno-19-23 href=#__codelineno-19-23></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>"style.css"</span>
|
||
<a id=__codelineno-19-24 name=__codelineno-19-24 href=#__codelineno-19-24></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>"script.js"</span>
|
||
</code></pre></div> <p>And voilá!! We've created our first component.</p> <h2 id=using-single-file-components>Using single-file components<a class=headerlink href=#using-single-file-components title="Permanent link">¤</a></h2> <p>Components can also be defined in a single file, which is useful for small components. To do this, you can use the <code>template</code>, <code>js</code>, and <code>css</code> class attributes instead of the <code>template_name</code> and <code>Media</code>. For example, here's the calendar component from above, defined in a single file:</p> <div class=highlight><span class=filename>[project root]/components/calendar.py</span><pre><span></span><code><a id=__codelineno-20-1 name=__codelineno-20-1 href=#__codelineno-20-1></a><span class=c1># In a file called [project root]/components/calendar.py</span>
|
||
<a id=__codelineno-20-2 name=__codelineno-20-2 href=#__codelineno-20-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span><span class=p>,</span> <span class=n>types</span>
|
||
<a id=__codelineno-20-3 name=__codelineno-20-3 href=#__codelineno-20-3></a>
|
||
<a id=__codelineno-20-4 name=__codelineno-20-4 href=#__codelineno-20-4></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-20-5 name=__codelineno-20-5 href=#__codelineno-20-5></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-20-6 name=__codelineno-20-6 href=#__codelineno-20-6></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>):</span>
|
||
<a id=__codelineno-20-7 name=__codelineno-20-7 href=#__codelineno-20-7></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-20-8 name=__codelineno-20-8 href=#__codelineno-20-8></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
||
<a id=__codelineno-20-9 name=__codelineno-20-9 href=#__codelineno-20-9></a> <span class=p>}</span>
|
||
<a id=__codelineno-20-10 name=__codelineno-20-10 href=#__codelineno-20-10></a>
|
||
<a id=__codelineno-20-11 name=__codelineno-20-11 href=#__codelineno-20-11></a> <span class=n>template</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>django_html</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-20-12 name=__codelineno-20-12 href=#__codelineno-20-12></a><span class=s2> <div class="calendar-component">Today's date is <span>{{ date }}</span></div></span>
|
||
<a id=__codelineno-20-13 name=__codelineno-20-13 href=#__codelineno-20-13></a><span class=s2> """</span>
|
||
<a id=__codelineno-20-14 name=__codelineno-20-14 href=#__codelineno-20-14></a>
|
||
<a id=__codelineno-20-15 name=__codelineno-20-15 href=#__codelineno-20-15></a> <span class=n>css</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>css</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-20-16 name=__codelineno-20-16 href=#__codelineno-20-16></a><span class=s2> .calendar-component { width: 200px; background: pink; }</span>
|
||
<a id=__codelineno-20-17 name=__codelineno-20-17 href=#__codelineno-20-17></a><span class=s2> .calendar-component span { font-weight: bold; }</span>
|
||
<a id=__codelineno-20-18 name=__codelineno-20-18 href=#__codelineno-20-18></a><span class=s2> """</span>
|
||
<a id=__codelineno-20-19 name=__codelineno-20-19 href=#__codelineno-20-19></a>
|
||
<a id=__codelineno-20-20 name=__codelineno-20-20 href=#__codelineno-20-20></a> <span class=n>js</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>js</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-20-21 name=__codelineno-20-21 href=#__codelineno-20-21></a><span class=s2> (function(){</span>
|
||
<a id=__codelineno-20-22 name=__codelineno-20-22 href=#__codelineno-20-22></a><span class=s2> if (document.querySelector(".calendar-component")) {</span>
|
||
<a id=__codelineno-20-23 name=__codelineno-20-23 href=#__codelineno-20-23></a><span class=s2> document.querySelector(".calendar-component").onclick = function(){ alert("Clicked calendar!"); };</span>
|
||
<a id=__codelineno-20-24 name=__codelineno-20-24 href=#__codelineno-20-24></a><span class=s2> }</span>
|
||
<a id=__codelineno-20-25 name=__codelineno-20-25 href=#__codelineno-20-25></a><span class=s2> })()</span>
|
||
<a id=__codelineno-20-26 name=__codelineno-20-26 href=#__codelineno-20-26></a><span class=s2> """</span>
|
||
</code></pre></div> <p>This makes it easy to create small components without having to create a separate template, CSS, and JS file.</p> <h3 id=syntax-highlight-and-code-assistance>Syntax highlight and code assistance<a class=headerlink href=#syntax-highlight-and-code-assistance title="Permanent link">¤</a></h3> <h4 id=vscode>VSCode<a class=headerlink href=#vscode title="Permanent link">¤</a></h4> <p>Note, in the above example, that the <code>t.django_html</code>, <code>t.css</code>, and <code>t.js</code> types are used to specify the type of the template, CSS, and JS files, respectively. This is not necessary, but if you're using VSCode with the <a href="https://marketplace.visualstudio.com/items?itemName=samwillis.python-inline-source">Python Inline Source Syntax Highlighting</a> extension, it will give you syntax highlighting for the template, CSS, and JS.</p> <h4 id=pycharm-or-other-jetbrains-ides>Pycharm (or other Jetbrains IDEs)<a class=headerlink href=#pycharm-or-other-jetbrains-ides title="Permanent link">¤</a></h4> <p>If you're a Pycharm user (or any other editor from Jetbrains), you can have coding assistance as well:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-21-2 name=__codelineno-21-2 href=#__codelineno-21-2></a>
|
||
<a id=__codelineno-21-3 name=__codelineno-21-3 href=#__codelineno-21-3></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-21-4 name=__codelineno-21-4 href=#__codelineno-21-4></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-21-5 name=__codelineno-21-5 href=#__codelineno-21-5></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>):</span>
|
||
<a id=__codelineno-21-6 name=__codelineno-21-6 href=#__codelineno-21-6></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-21-7 name=__codelineno-21-7 href=#__codelineno-21-7></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
||
<a id=__codelineno-21-8 name=__codelineno-21-8 href=#__codelineno-21-8></a> <span class=p>}</span>
|
||
<a id=__codelineno-21-9 name=__codelineno-21-9 href=#__codelineno-21-9></a>
|
||
<a id=__codelineno-21-10 name=__codelineno-21-10 href=#__codelineno-21-10></a> <span class=c1># language=HTML</span>
|
||
<a id=__codelineno-21-11 name=__codelineno-21-11 href=#__codelineno-21-11></a> <span class=n>template</span><span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-21-12 name=__codelineno-21-12 href=#__codelineno-21-12></a><span class=s2> <div class="calendar-component">Today's date is <span>{{ date }}</span></div></span>
|
||
<a id=__codelineno-21-13 name=__codelineno-21-13 href=#__codelineno-21-13></a><span class=s2> """</span>
|
||
<a id=__codelineno-21-14 name=__codelineno-21-14 href=#__codelineno-21-14></a>
|
||
<a id=__codelineno-21-15 name=__codelineno-21-15 href=#__codelineno-21-15></a> <span class=c1># language=CSS</span>
|
||
<a id=__codelineno-21-16 name=__codelineno-21-16 href=#__codelineno-21-16></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-21-17 name=__codelineno-21-17 href=#__codelineno-21-17></a><span class=s2> .calendar-component { width: 200px; background: pink; }</span>
|
||
<a id=__codelineno-21-18 name=__codelineno-21-18 href=#__codelineno-21-18></a><span class=s2> .calendar-component span { font-weight: bold; }</span>
|
||
<a id=__codelineno-21-19 name=__codelineno-21-19 href=#__codelineno-21-19></a><span class=s2> """</span>
|
||
<a id=__codelineno-21-20 name=__codelineno-21-20 href=#__codelineno-21-20></a>
|
||
<a id=__codelineno-21-21 name=__codelineno-21-21 href=#__codelineno-21-21></a> <span class=c1># language=JS</span>
|
||
<a id=__codelineno-21-22 name=__codelineno-21-22 href=#__codelineno-21-22></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-21-23 name=__codelineno-21-23 href=#__codelineno-21-23></a><span class=s2> (function(){</span>
|
||
<a id=__codelineno-21-24 name=__codelineno-21-24 href=#__codelineno-21-24></a><span class=s2> if (document.querySelector(".calendar-component")) {</span>
|
||
<a id=__codelineno-21-25 name=__codelineno-21-25 href=#__codelineno-21-25></a><span class=s2> document.querySelector(".calendar-component").onclick = function(){ alert("Clicked calendar!"); };</span>
|
||
<a id=__codelineno-21-26 name=__codelineno-21-26 href=#__codelineno-21-26></a><span class=s2> }</span>
|
||
<a id=__codelineno-21-27 name=__codelineno-21-27 href=#__codelineno-21-27></a><span class=s2> })()</span>
|
||
<a id=__codelineno-21-28 name=__codelineno-21-28 href=#__codelineno-21-28></a><span class=s2> """</span>
|
||
</code></pre></div> <p>You don't need to use <code>types.django_html</code>, <code>types.css</code>, <code>types.js</code> since Pycharm uses <a href=https://www.jetbrains.com/help/pycharm/using-language-injections.html>language injections</a>. You only need to write the comments <code># language=<lang></code> above the variables.</p> <h2 id=use-components-in-templates>Use components in templates<a class=headerlink href=#use-components-in-templates title="Permanent link">¤</a></h2> <p>First load the <code>component_tags</code> tag library, then use the <code>component_[js/css]_dependencies</code> and <code>component</code> tags to render the component to the page.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-22-1 name=__codelineno-22-1 href=#__codelineno-22-1></a><span class=cp>{%</span> <span class=k>load</span> <span class=nv>component_tags</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-22-2 name=__codelineno-22-2 href=#__codelineno-22-2></a><span class=cp><!DOCTYPE html></span>
|
||
<a id=__codelineno-22-3 name=__codelineno-22-3 href=#__codelineno-22-3></a><span class=p><</span><span class=nt>html</span><span class=p>></span>
|
||
<a id=__codelineno-22-4 name=__codelineno-22-4 href=#__codelineno-22-4></a><span class=p><</span><span class=nt>head</span><span class=p>></span>
|
||
<a id=__codelineno-22-5 name=__codelineno-22-5 href=#__codelineno-22-5></a> <span class=p><</span><span class=nt>title</span><span class=p>></span>My example calendar<span class=p></</span><span class=nt>title</span><span class=p>></span>
|
||
<a id=__codelineno-22-6 name=__codelineno-22-6 href=#__codelineno-22-6></a> <span class=cp>{%</span> <span class=k>component_css_dependencies</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-22-7 name=__codelineno-22-7 href=#__codelineno-22-7></a><span class=p></</span><span class=nt>head</span><span class=p>></span>
|
||
<a id=__codelineno-22-8 name=__codelineno-22-8 href=#__codelineno-22-8></a><span class=p><</span><span class=nt>body</span><span class=p>></span>
|
||
<a id=__codelineno-22-9 name=__codelineno-22-9 href=#__codelineno-22-9></a> <span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2015-06-19"</span> <span class=cp>%}{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-22-10 name=__codelineno-22-10 href=#__codelineno-22-10></a> <span class=cp>{%</span> <span class=k>component_js_dependencies</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-22-11 name=__codelineno-22-11 href=#__codelineno-22-11></a><span class=p></</span><span class=nt>body</span><span class=p>></span>
|
||
<a id=__codelineno-22-12 name=__codelineno-22-12 href=#__codelineno-22-12></a><span class=p><</span><span class=nt>html</span><span class=p>></span>
|
||
</code></pre></div> <blockquote> <p>NOTE: Instead of writing <code>{% endcomponent %}</code> at the end, you can use a self-closing tag:</p> <p><code>{% component "calendar" date="2015-06-19" / %}</code></p> </blockquote> <p>The output from the above template will be:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-23-1 name=__codelineno-23-1 href=#__codelineno-23-1></a><span class=cp><!DOCTYPE html></span>
|
||
<a id=__codelineno-23-2 name=__codelineno-23-2 href=#__codelineno-23-2></a><span class=p><</span><span class=nt>html</span><span class=p>></span>
|
||
<a id=__codelineno-23-3 name=__codelineno-23-3 href=#__codelineno-23-3></a> <span class=p><</span><span class=nt>head</span><span class=p>></span>
|
||
<a id=__codelineno-23-4 name=__codelineno-23-4 href=#__codelineno-23-4></a> <span class=p><</span><span class=nt>title</span><span class=p>></span>My example calendar<span class=p></</span><span class=nt>title</span><span class=p>></span>
|
||
<a id=__codelineno-23-5 name=__codelineno-23-5 href=#__codelineno-23-5></a> <span class=p><</span><span class=nt>link</span>
|
||
<a id=__codelineno-23-6 name=__codelineno-23-6 href=#__codelineno-23-6></a> <span class=na>href</span><span class=o>=</span><span class=s>"/static/calendar/style.css"</span>
|
||
<a id=__codelineno-23-7 name=__codelineno-23-7 href=#__codelineno-23-7></a> <span class=na>type</span><span class=o>=</span><span class=s>"text/css"</span>
|
||
<a id=__codelineno-23-8 name=__codelineno-23-8 href=#__codelineno-23-8></a> <span class=na>media</span><span class=o>=</span><span class=s>"all"</span>
|
||
<a id=__codelineno-23-9 name=__codelineno-23-9 href=#__codelineno-23-9></a> <span class=na>rel</span><span class=o>=</span><span class=s>"stylesheet"</span>
|
||
<a id=__codelineno-23-10 name=__codelineno-23-10 href=#__codelineno-23-10></a> <span class=p>/></span>
|
||
<a id=__codelineno-23-11 name=__codelineno-23-11 href=#__codelineno-23-11></a> <span class=p></</span><span class=nt>head</span><span class=p>></span>
|
||
<a id=__codelineno-23-12 name=__codelineno-23-12 href=#__codelineno-23-12></a> <span class=p><</span><span class=nt>body</span><span class=p>></span>
|
||
<a id=__codelineno-23-13 name=__codelineno-23-13 href=#__codelineno-23-13></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-23-14 name=__codelineno-23-14 href=#__codelineno-23-14></a> Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span>2015-06-19<span class=p></</span><span class=nt>span</span><span class=p>></span>
|
||
<a id=__codelineno-23-15 name=__codelineno-23-15 href=#__codelineno-23-15></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-23-16 name=__codelineno-23-16 href=#__codelineno-23-16></a> <span class=p><</span><span class=nt>script</span> <span class=na>src</span><span class=o>=</span><span class=s>"/static/calendar/script.js"</span><span class=p>></</span><span class=nt>script</span><span class=p>></span>
|
||
<a id=__codelineno-23-17 name=__codelineno-23-17 href=#__codelineno-23-17></a> <span class=p></</span><span class=nt>body</span><span class=p>></span>
|
||
<a id=__codelineno-23-18 name=__codelineno-23-18 href=#__codelineno-23-18></a> <span class=p><</span><span class=nt>html</span><span class=p>></</span><span class=nt>html</span><span class=p>></span>
|
||
<a id=__codelineno-23-19 name=__codelineno-23-19 href=#__codelineno-23-19></a><span class=p></</span><span class=nt>html</span><span class=p>></span>
|
||
</code></pre></div> <p>This makes it possible to organize your front-end around reusable components. Instead of relying on template tags and keeping your CSS and Javascript in the static directory.</p> <h2 id=use-components-outside-of-templates>Use components outside of templates<a class=headerlink href=#use-components-outside-of-templates title="Permanent link">¤</a></h2> <p><em>New in version 0.81</em></p> <p>Components can be rendered outside of Django templates, calling them as regular functions ("React-style").</p> <p>The component class defines <code>render</code> and <code>render_to_response</code> class methods. These methods accept positional args, kwargs, and slots, offering the same flexibility as the <code>{% component %}</code> tag:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-24-1 name=__codelineno-24-1 href=#__codelineno-24-1></a><span class=k>class</span> <span class=nc>SimpleComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-24-2 name=__codelineno-24-2 href=#__codelineno-24-2></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-24-3 name=__codelineno-24-3 href=#__codelineno-24-3></a><span class=s2> {</span><span class=si>% lo</span><span class=s2>ad component_tags %}</span>
|
||
<a id=__codelineno-24-4 name=__codelineno-24-4 href=#__codelineno-24-4></a><span class=s2> hello: {{ hello }}</span>
|
||
<a id=__codelineno-24-5 name=__codelineno-24-5 href=#__codelineno-24-5></a><span class=s2> foo: {{ foo }}</span>
|
||
<a id=__codelineno-24-6 name=__codelineno-24-6 href=#__codelineno-24-6></a><span class=s2> kwargs: {{ kwargs|safe }}</span>
|
||
<a id=__codelineno-24-7 name=__codelineno-24-7 href=#__codelineno-24-7></a><span class=s2> slot_first: {</span><span class=si>% s</span><span class=s2>lot "first" required / %}</span>
|
||
<a id=__codelineno-24-8 name=__codelineno-24-8 href=#__codelineno-24-8></a><span class=s2> """</span>
|
||
<a id=__codelineno-24-9 name=__codelineno-24-9 href=#__codelineno-24-9></a>
|
||
<a id=__codelineno-24-10 name=__codelineno-24-10 href=#__codelineno-24-10></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>arg1</span><span class=p>,</span> <span class=n>arg2</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-24-11 name=__codelineno-24-11 href=#__codelineno-24-11></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-24-12 name=__codelineno-24-12 href=#__codelineno-24-12></a> <span class=s2>"hello"</span><span class=p>:</span> <span class=n>arg1</span><span class=p>,</span>
|
||
<a id=__codelineno-24-13 name=__codelineno-24-13 href=#__codelineno-24-13></a> <span class=s2>"foo"</span><span class=p>:</span> <span class=n>arg2</span><span class=p>,</span>
|
||
<a id=__codelineno-24-14 name=__codelineno-24-14 href=#__codelineno-24-14></a> <span class=s2>"kwargs"</span><span class=p>:</span> <span class=n>kwargs</span><span class=p>,</span>
|
||
<a id=__codelineno-24-15 name=__codelineno-24-15 href=#__codelineno-24-15></a> <span class=p>}</span>
|
||
<a id=__codelineno-24-16 name=__codelineno-24-16 href=#__codelineno-24-16></a>
|
||
<a id=__codelineno-24-17 name=__codelineno-24-17 href=#__codelineno-24-17></a><span class=n>rendered</span> <span class=o>=</span> <span class=n>SimpleComponent</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-24-18 name=__codelineno-24-18 href=#__codelineno-24-18></a> <span class=n>args</span><span class=o>=</span><span class=p>[</span><span class=s2>"world"</span><span class=p>,</span> <span class=s2>"bar"</span><span class=p>],</span>
|
||
<a id=__codelineno-24-19 name=__codelineno-24-19 href=#__codelineno-24-19></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span><span class=s2>"kw1"</span><span class=p>:</span> <span class=s2>"test"</span><span class=p>,</span> <span class=s2>"kw2"</span><span class=p>:</span> <span class=s2>"ooo"</span><span class=p>},</span>
|
||
<a id=__codelineno-24-20 name=__codelineno-24-20 href=#__codelineno-24-20></a> <span class=n>slots</span><span class=o>=</span><span class=p>{</span><span class=s2>"first"</span><span class=p>:</span> <span class=s2>"FIRST_SLOT"</span><span class=p>},</span>
|
||
<a id=__codelineno-24-21 name=__codelineno-24-21 href=#__codelineno-24-21></a> <span class=n>context</span><span class=o>=</span><span class=p>{</span><span class=s2>"from_context"</span><span class=p>:</span> <span class=mi>98</span><span class=p>},</span>
|
||
<a id=__codelineno-24-22 name=__codelineno-24-22 href=#__codelineno-24-22></a><span class=p>)</span>
|
||
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-25-1 name=__codelineno-25-1 href=#__codelineno-25-1></a>hello: world
|
||
<a id=__codelineno-25-2 name=__codelineno-25-2 href=#__codelineno-25-2></a>foo: bar
|
||
<a id=__codelineno-25-3 name=__codelineno-25-3 href=#__codelineno-25-3></a>kwargs: {'kw1': 'test', 'kw2': 'ooo'}
|
||
<a id=__codelineno-25-4 name=__codelineno-25-4 href=#__codelineno-25-4></a>slot_first: FIRST_SLOT
|
||
</code></pre></div> <h3 id=inputs-of-render-and-render_to_response>Inputs of <code>render</code> and <code>render_to_response</code><a class=headerlink href=#inputs-of-render-and-render_to_response title="Permanent link">¤</a></h3> <p>Both <code>render</code> and <code>render_to_response</code> accept the same input:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-26-1 name=__codelineno-26-1 href=#__codelineno-26-1></a><span class=n>Component</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-26-2 name=__codelineno-26-2 href=#__codelineno-26-2></a> <span class=n>context</span><span class=p>:</span> <span class=n>Mapping</span> <span class=o>|</span> <span class=n>django</span><span class=o>.</span><span class=n>template</span><span class=o>.</span><span class=n>Context</span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-26-3 name=__codelineno-26-3 href=#__codelineno-26-3></a> <span class=n>args</span><span class=p>:</span> <span class=n>List</span><span class=p>[</span><span class=n>Any</span><span class=p>]</span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-26-4 name=__codelineno-26-4 href=#__codelineno-26-4></a> <span class=n>kwargs</span><span class=p>:</span> <span class=n>Dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=n>Any</span><span class=p>]</span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-26-5 name=__codelineno-26-5 href=#__codelineno-26-5></a> <span class=n>slots</span><span class=p>:</span> <span class=n>Dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=nb>str</span> <span class=o>|</span> <span class=n>SafeString</span> <span class=o>|</span> <span class=n>SlotFunc</span><span class=p>]</span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-26-6 name=__codelineno-26-6 href=#__codelineno-26-6></a> <span class=n>escape_slots_content</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=kc>True</span>
|
||
<a id=__codelineno-26-7 name=__codelineno-26-7 href=#__codelineno-26-7></a><span class=p>)</span> <span class=o>-></span> <span class=nb>str</span><span class=p>:</span>
|
||
</code></pre></div> <ul> <li> <p><em><code>args</code></em> - Positional args for the component. This is the same as calling the component as <code>{% component "my_comp" arg1 arg2 ... %}</code></p> </li> <li> <p><em><code>kwargs</code></em> - Keyword args for the component. This is the same as calling the component as <code>{% component "my_comp" key1=val1 key2=val2 ... %}</code></p> </li> <li> <p><em><code>slots</code></em> - Component slot fills. This is the same as pasing <code>{% fill %}</code> tags to the component. Accepts a dictionary of <code>{ slot_name: slot_content }</code> where <code>slot_content</code> can be a string or <a href=#slotfunc><code>SlotFunc</code></a>.</p> </li> <li> <p><em><code>escape_slots_content</code></em> - Whether the content from <code>slots</code> should be escaped. <code>True</code> by default to prevent XSS attacks. If you disable escaping, you should make sure that any content you pass to the slots is safe, especially if it comes from user input.</p> </li> <li> <p><em><code>context</code></em> - A context (dictionary or Django's Context) within which the component is rendered. The keys on the context can be accessed from within the template.</p> </li> <li>NOTE: In "isolated" mode, context is NOT accessible, and data MUST be passed via component's args and kwargs.</li> </ul> <h4 id=slotfunc><code>SlotFunc</code><a class=headerlink href=#slotfunc title="Permanent link">¤</a></h4> <p>When rendering components with slots in <code>render</code> or <code>render_to_response</code>, you can pass either a string or a function.</p> <p>The function has following signature:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-27-1 name=__codelineno-27-1 href=#__codelineno-27-1></a><span class=k>def</span> <span class=nf>render_func</span><span class=p>(</span>
|
||
<a id=__codelineno-27-2 name=__codelineno-27-2 href=#__codelineno-27-2></a> <span class=n>context</span><span class=p>:</span> <span class=n>Context</span><span class=p>,</span>
|
||
<a id=__codelineno-27-3 name=__codelineno-27-3 href=#__codelineno-27-3></a> <span class=n>data</span><span class=p>:</span> <span class=n>Dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=n>Any</span><span class=p>],</span>
|
||
<a id=__codelineno-27-4 name=__codelineno-27-4 href=#__codelineno-27-4></a> <span class=n>slot_ref</span><span class=p>:</span> <span class=n>SlotRef</span><span class=p>,</span>
|
||
<a id=__codelineno-27-5 name=__codelineno-27-5 href=#__codelineno-27-5></a><span class=p>)</span> <span class=o>-></span> <span class=nb>str</span> <span class=o>|</span> <span class=n>SafeString</span><span class=p>:</span>
|
||
<a id=__codelineno-27-6 name=__codelineno-27-6 href=#__codelineno-27-6></a> <span class=k>return</span> <span class=n>nodelist</span><span class=o>.</span><span class=n>render</span><span class=p>(</span><span class=n>ctx</span><span class=p>)</span>
|
||
</code></pre></div> <ul> <li><em><code>context</code></em> - Django's Context available to the Slot Node.</li> <li><em><code>data</code></em> - Data passed to the <code>{% slot %}</code> tag. See <a href=#scoped-slots>Scoped Slots</a>.</li> <li><em><code>slot_ref</code></em> - The default slot content. See <a href=#accessing-original-content-of-slots>Accessing original content of slots</a>.</li> <li>NOTE: The slot is lazily evaluated. To render the slot, convert it to string with <code>str(slot_ref)</code>.</li> </ul> <p>Example:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-28-1 name=__codelineno-28-1 href=#__codelineno-28-1></a><span class=k>def</span> <span class=nf>footer_slot</span><span class=p>(</span><span class=n>ctx</span><span class=p>,</span> <span class=n>data</span><span class=p>,</span> <span class=n>slot_ref</span><span class=p>):</span>
|
||
<a id=__codelineno-28-2 name=__codelineno-28-2 href=#__codelineno-28-2></a> <span class=k>return</span> <span class=sa>f</span><span class=s2>"""</span>
|
||
<a id=__codelineno-28-3 name=__codelineno-28-3 href=#__codelineno-28-3></a><span class=s2> SLOT_DATA: </span><span class=si>{</span><span class=n>data</span><span class=p>[</span><span class=s1>'abc'</span><span class=p>]</span><span class=si>}</span>
|
||
<a id=__codelineno-28-4 name=__codelineno-28-4 href=#__codelineno-28-4></a><span class=s2> ORIGINAL: </span><span class=si>{</span><span class=n>slot_ref</span><span class=si>}</span>
|
||
<a id=__codelineno-28-5 name=__codelineno-28-5 href=#__codelineno-28-5></a><span class=s2> """</span>
|
||
<a id=__codelineno-28-6 name=__codelineno-28-6 href=#__codelineno-28-6></a>
|
||
<a id=__codelineno-28-7 name=__codelineno-28-7 href=#__codelineno-28-7></a><span class=n>MyComponent</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||
<a id=__codelineno-28-8 name=__codelineno-28-8 href=#__codelineno-28-8></a> <span class=n>slots</span><span class=o>=</span><span class=p>{</span>
|
||
<a id=__codelineno-28-9 name=__codelineno-28-9 href=#__codelineno-28-9></a> <span class=s2>"footer"</span><span class=p>:</span> <span class=n>footer_slot</span><span class=p>,</span>
|
||
<a id=__codelineno-28-10 name=__codelineno-28-10 href=#__codelineno-28-10></a> <span class=p>},</span>
|
||
<a id=__codelineno-28-11 name=__codelineno-28-11 href=#__codelineno-28-11></a><span class=p>)</span>
|
||
</code></pre></div> <h3 id=response-class-of-render_to_response>Response class of <code>render_to_response</code><a class=headerlink href=#response-class-of-render_to_response title="Permanent link">¤</a></h3> <p>While <code>render</code> method returns a plain string, <code>render_to_response</code> wraps the rendered content in a "Response" class. By default, this is <code>django.http.HttpResponse</code>.</p> <p>If you want to use a different Response class in <code>render_to_response</code>, set the <code>Component.response_class</code> attribute:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-29-1 name=__codelineno-29-1 href=#__codelineno-29-1></a><span class=k>class</span> <span class=nc>MyResponse</span><span class=p>(</span><span class=n>HttpResponse</span><span class=p>):</span>
|
||
<a id=__codelineno-29-2 name=__codelineno-29-2 href=#__codelineno-29-2></a> <span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||
<a id=__codelineno-29-3 name=__codelineno-29-3 href=#__codelineno-29-3></a> <span class=nb>super</span><span class=p>()</span><span class=o>.</span><span class=fm>__init__</span><span class=p>(</span><span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
|
||
<a id=__codelineno-29-4 name=__codelineno-29-4 href=#__codelineno-29-4></a> <span class=c1># Configure response</span>
|
||
<a id=__codelineno-29-5 name=__codelineno-29-5 href=#__codelineno-29-5></a> <span class=bp>self</span><span class=o>.</span><span class=n>headers</span> <span class=o>=</span> <span class=o>...</span>
|
||
<a id=__codelineno-29-6 name=__codelineno-29-6 href=#__codelineno-29-6></a> <span class=bp>self</span><span class=o>.</span><span class=n>status</span> <span class=o>=</span> <span class=o>...</span>
|
||
<a id=__codelineno-29-7 name=__codelineno-29-7 href=#__codelineno-29-7></a>
|
||
<a id=__codelineno-29-8 name=__codelineno-29-8 href=#__codelineno-29-8></a><span class=k>class</span> <span class=nc>SimpleComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-29-9 name=__codelineno-29-9 href=#__codelineno-29-9></a> <span class=n>response_class</span> <span class=o>=</span> <span class=n>MyResponse</span>
|
||
<a id=__codelineno-29-10 name=__codelineno-29-10 href=#__codelineno-29-10></a> <span class=n>template</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>django_html</span> <span class=o>=</span> <span class=s2>"HELLO"</span>
|
||
<a id=__codelineno-29-11 name=__codelineno-29-11 href=#__codelineno-29-11></a>
|
||
<a id=__codelineno-29-12 name=__codelineno-29-12 href=#__codelineno-29-12></a><span class=n>response</span> <span class=o>=</span> <span class=n>SimpleComponent</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>()</span>
|
||
<a id=__codelineno-29-13 name=__codelineno-29-13 href=#__codelineno-29-13></a><span class=k>assert</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>response</span><span class=p>,</span> <span class=n>MyResponse</span><span class=p>)</span>
|
||
</code></pre></div> <h2 id=use-components-as-views>Use components as views<a class=headerlink href=#use-components-as-views title="Permanent link">¤</a></h2> <p><em>New in version 0.34</em></p> <p><em>Note: Since 0.92, Component no longer subclasses View. To configure the View class, set the nested <code>Component.View</code> class</em></p> <p>Components can now be used as views: - Components define the <code>Component.as_view()</code> class method that can be used the same as <a href=https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View.as_view><code>View.as_view()</code></a>.</p> <ul> <li> <p>By default, you can define GET, POST or other HTTP handlers directly on the Component, same as you do with <a href=https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#view>View</a>. For example, you can override <code>get</code> and <code>post</code> to handle GET and POST requests, respectively.</p> </li> <li> <p>In addition, <code>Component</code> now has a <a href=#inputs-of-render-and-render_to_response><code>render_to_response</code></a> method that renders the component template based on the provided context and slots' data and returns an <code>HttpResponse</code> object.</p> </li> </ul> <h3 id=component-as-view-example>Component as view example<a class=headerlink href=#component-as-view-example title="Permanent link">¤</a></h3> <p>Here's an example of a calendar component defined as a view:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-30-1 name=__codelineno-30-1 href=#__codelineno-30-1></a><span class=c1># In a file called [project root]/components/calendar.py</span>
|
||
<a id=__codelineno-30-2 name=__codelineno-30-2 href=#__codelineno-30-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>ComponentView</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-30-3 name=__codelineno-30-3 href=#__codelineno-30-3></a>
|
||
<a id=__codelineno-30-4 name=__codelineno-30-4 href=#__codelineno-30-4></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-30-5 name=__codelineno-30-5 href=#__codelineno-30-5></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-30-6 name=__codelineno-30-6 href=#__codelineno-30-6></a>
|
||
<a id=__codelineno-30-7 name=__codelineno-30-7 href=#__codelineno-30-7></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-30-8 name=__codelineno-30-8 href=#__codelineno-30-8></a><span class=s2> <div class="calendar-component"></span>
|
||
<a id=__codelineno-30-9 name=__codelineno-30-9 href=#__codelineno-30-9></a><span class=s2> <div class="header"></span>
|
||
<a id=__codelineno-30-10 name=__codelineno-30-10 href=#__codelineno-30-10></a><span class=s2> {</span><span class=si>% s</span><span class=s2>lot "header" / %}</span>
|
||
<a id=__codelineno-30-11 name=__codelineno-30-11 href=#__codelineno-30-11></a><span class=s2> </div></span>
|
||
<a id=__codelineno-30-12 name=__codelineno-30-12 href=#__codelineno-30-12></a><span class=s2> <div class="body"></span>
|
||
<a id=__codelineno-30-13 name=__codelineno-30-13 href=#__codelineno-30-13></a><span class=s2> Today's date is <span>{{ date }}</span></span>
|
||
<a id=__codelineno-30-14 name=__codelineno-30-14 href=#__codelineno-30-14></a><span class=s2> </div></span>
|
||
<a id=__codelineno-30-15 name=__codelineno-30-15 href=#__codelineno-30-15></a><span class=s2> </div></span>
|
||
<a id=__codelineno-30-16 name=__codelineno-30-16 href=#__codelineno-30-16></a><span class=s2> """</span>
|
||
<a id=__codelineno-30-17 name=__codelineno-30-17 href=#__codelineno-30-17></a>
|
||
<a id=__codelineno-30-18 name=__codelineno-30-18 href=#__codelineno-30-18></a> <span class=c1># Handle GET requests</span>
|
||
<a id=__codelineno-30-19 name=__codelineno-30-19 href=#__codelineno-30-19></a> <span class=k>def</span> <span class=nf>get</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-30-20 name=__codelineno-30-20 href=#__codelineno-30-20></a> <span class=n>context</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-30-21 name=__codelineno-30-21 href=#__codelineno-30-21></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>request</span><span class=o>.</span><span class=n>GET</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s2>"date"</span><span class=p>,</span> <span class=s2>"2020-06-06"</span><span class=p>),</span>
|
||
<a id=__codelineno-30-22 name=__codelineno-30-22 href=#__codelineno-30-22></a> <span class=p>}</span>
|
||
<a id=__codelineno-30-23 name=__codelineno-30-23 href=#__codelineno-30-23></a> <span class=n>slots</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-30-24 name=__codelineno-30-24 href=#__codelineno-30-24></a> <span class=s2>"header"</span><span class=p>:</span> <span class=s2>"Calendar header"</span><span class=p>,</span>
|
||
<a id=__codelineno-30-25 name=__codelineno-30-25 href=#__codelineno-30-25></a> <span class=p>}</span>
|
||
<a id=__codelineno-30-26 name=__codelineno-30-26 href=#__codelineno-30-26></a> <span class=c1># Return HttpResponse with the rendered content</span>
|
||
<a id=__codelineno-30-27 name=__codelineno-30-27 href=#__codelineno-30-27></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||
<a id=__codelineno-30-28 name=__codelineno-30-28 href=#__codelineno-30-28></a> <span class=n>context</span><span class=o>=</span><span class=n>context</span><span class=p>,</span>
|
||
<a id=__codelineno-30-29 name=__codelineno-30-29 href=#__codelineno-30-29></a> <span class=n>slots</span><span class=o>=</span><span class=n>slots</span><span class=p>,</span>
|
||
<a id=__codelineno-30-30 name=__codelineno-30-30 href=#__codelineno-30-30></a> <span class=p>)</span>
|
||
</code></pre></div> <p>Then, to use this component as a view, you should create a <code>urls.py</code> file in your components directory, and add a path to the component's view:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-31-1 name=__codelineno-31-1 href=#__codelineno-31-1></a><span class=c1># In a file called [project root]/components/urls.py</span>
|
||
<a id=__codelineno-31-2 name=__codelineno-31-2 href=#__codelineno-31-2></a><span class=kn>from</span> <span class=nn>django.urls</span> <span class=kn>import</span> <span class=n>path</span>
|
||
<a id=__codelineno-31-3 name=__codelineno-31-3 href=#__codelineno-31-3></a><span class=kn>from</span> <span class=nn>components.calendar.calendar</span> <span class=kn>import</span> <span class=n>Calendar</span>
|
||
<a id=__codelineno-31-4 name=__codelineno-31-4 href=#__codelineno-31-4></a>
|
||
<a id=__codelineno-31-5 name=__codelineno-31-5 href=#__codelineno-31-5></a><span class=n>urlpatterns</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-31-6 name=__codelineno-31-6 href=#__codelineno-31-6></a> <span class=n>path</span><span class=p>(</span><span class=s2>"calendar/"</span><span class=p>,</span> <span class=n>Calendar</span><span class=o>.</span><span class=n>as_view</span><span class=p>()),</span>
|
||
<a id=__codelineno-31-7 name=__codelineno-31-7 href=#__codelineno-31-7></a><span class=p>]</span>
|
||
</code></pre></div> <p><code>Component.as_view()</code> is a shorthand for calling <a href=https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View.as_view><code>View.as_view()</code></a> and passing the component instance as one of the arguments.</p> <p>Remember to add <code>__init__.py</code> to your components directory, so that Django can find the <code>urls.py</code> file.</p> <p>Finally, include the component's urls in your project's <code>urls.py</code> file:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-32-1 name=__codelineno-32-1 href=#__codelineno-32-1></a><span class=c1># In a file called [project root]/urls.py</span>
|
||
<a id=__codelineno-32-2 name=__codelineno-32-2 href=#__codelineno-32-2></a><span class=kn>from</span> <span class=nn>django.urls</span> <span class=kn>import</span> <span class=n>include</span><span class=p>,</span> <span class=n>path</span>
|
||
<a id=__codelineno-32-3 name=__codelineno-32-3 href=#__codelineno-32-3></a>
|
||
<a id=__codelineno-32-4 name=__codelineno-32-4 href=#__codelineno-32-4></a><span class=n>urlpatterns</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-32-5 name=__codelineno-32-5 href=#__codelineno-32-5></a> <span class=n>path</span><span class=p>(</span><span class=s2>"components/"</span><span class=p>,</span> <span class=n>include</span><span class=p>(</span><span class=s2>"components.urls"</span><span class=p>)),</span>
|
||
<a id=__codelineno-32-6 name=__codelineno-32-6 href=#__codelineno-32-6></a><span class=p>]</span>
|
||
</code></pre></div> <p>Note: Slots content are automatically escaped by default to prevent XSS attacks. To disable escaping, set <code>escape_slots_content=False</code> in the <code>render_to_response</code> method. If you do so, you should make sure that any content you pass to the slots is safe, especially if it comes from user input.</p> <p>If you're planning on passing an HTML string, check Django's use of <a href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.html.format_html><code>format_html</code></a> and <a href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.mark_safe><code>mark_safe</code></a>.</p> <h3 id=modifying-the-view-class>Modifying the View class<a class=headerlink href=#modifying-the-view-class title="Permanent link">¤</a></h3> <p>The View class that handles the requests is defined on <code>Component.View</code>.</p> <p>When you define a GET or POST handlers on the <code>Component</code> class, like so:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-33-1 name=__codelineno-33-1 href=#__codelineno-33-1></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-33-2 name=__codelineno-33-2 href=#__codelineno-33-2></a> <span class=k>def</span> <span class=nf>get</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-33-3 name=__codelineno-33-3 href=#__codelineno-33-3></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||
<a id=__codelineno-33-4 name=__codelineno-33-4 href=#__codelineno-33-4></a> <span class=n>context</span><span class=o>=</span><span class=p>{</span>
|
||
<a id=__codelineno-33-5 name=__codelineno-33-5 href=#__codelineno-33-5></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>request</span><span class=o>.</span><span class=n>GET</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s2>"date"</span><span class=p>,</span> <span class=s2>"2020-06-06"</span><span class=p>),</span>
|
||
<a id=__codelineno-33-6 name=__codelineno-33-6 href=#__codelineno-33-6></a> <span class=p>},</span>
|
||
<a id=__codelineno-33-7 name=__codelineno-33-7 href=#__codelineno-33-7></a> <span class=p>)</span>
|
||
<a id=__codelineno-33-8 name=__codelineno-33-8 href=#__codelineno-33-8></a>
|
||
<a id=__codelineno-33-9 name=__codelineno-33-9 href=#__codelineno-33-9></a> <span class=k>def</span> <span class=nf>post</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span> <span class=o>-></span> <span class=n>HttpResponse</span><span class=p>:</span>
|
||
<a id=__codelineno-33-10 name=__codelineno-33-10 href=#__codelineno-33-10></a> <span class=n>variable</span> <span class=o>=</span> <span class=n>request</span><span class=o>.</span><span class=n>POST</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s2>"variable"</span><span class=p>)</span>
|
||
<a id=__codelineno-33-11 name=__codelineno-33-11 href=#__codelineno-33-11></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||
<a id=__codelineno-33-12 name=__codelineno-33-12 href=#__codelineno-33-12></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span><span class=s2>"variable"</span><span class=p>:</span> <span class=n>variable</span><span class=p>}</span>
|
||
<a id=__codelineno-33-13 name=__codelineno-33-13 href=#__codelineno-33-13></a> <span class=p>)</span>
|
||
</code></pre></div> <p>Then the request is still handled by <code>Component.View.get()</code> or <code>Component.View.post()</code> methods. However, by default, <code>Component.View.get()</code> points to <code>Component.get()</code>, and so on.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-34-1 name=__codelineno-34-1 href=#__codelineno-34-1></a><span class=k>class</span> <span class=nc>ComponentView</span><span class=p>(</span><span class=n>View</span><span class=p>):</span>
|
||
<a id=__codelineno-34-2 name=__codelineno-34-2 href=#__codelineno-34-2></a> <span class=n>component</span><span class=p>:</span> <span class=n>Component</span> <span class=o>=</span> <span class=kc>None</span>
|
||
<a id=__codelineno-34-3 name=__codelineno-34-3 href=#__codelineno-34-3></a> <span class=o>...</span>
|
||
<a id=__codelineno-34-4 name=__codelineno-34-4 href=#__codelineno-34-4></a>
|
||
<a id=__codelineno-34-5 name=__codelineno-34-5 href=#__codelineno-34-5></a> <span class=k>def</span> <span class=nf>get</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-34-6 name=__codelineno-34-6 href=#__codelineno-34-6></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>component</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
|
||
<a id=__codelineno-34-7 name=__codelineno-34-7 href=#__codelineno-34-7></a>
|
||
<a id=__codelineno-34-8 name=__codelineno-34-8 href=#__codelineno-34-8></a> <span class=k>def</span> <span class=nf>post</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-34-9 name=__codelineno-34-9 href=#__codelineno-34-9></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>component</span><span class=o>.</span><span class=n>post</span><span class=p>(</span><span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
|
||
<a id=__codelineno-34-10 name=__codelineno-34-10 href=#__codelineno-34-10></a>
|
||
<a id=__codelineno-34-11 name=__codelineno-34-11 href=#__codelineno-34-11></a> <span class=o>...</span>
|
||
</code></pre></div> <p>If you want to define your own <code>View</code> class, you need to: 1. Set the class as <code>Component.View</code> 2. Subclass from <code>ComponentView</code>, so the View instance has access to the component instance.</p> <p>In the example below, we added extra logic into <code>View.setup()</code>.</p> <p>Note that the POST handler is still defined at the top. This is because <code>View</code> subclasses <code>ComponentView</code>, which defines the <code>post()</code> method that calls <code>Component.post()</code>.</p> <p>If you were to overwrite the <code>View.post()</code> method, then <code>Component.post()</code> would be ignored.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-35-1 name=__codelineno-35-1 href=#__codelineno-35-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>ComponentView</span>
|
||
<a id=__codelineno-35-2 name=__codelineno-35-2 href=#__codelineno-35-2></a>
|
||
<a id=__codelineno-35-3 name=__codelineno-35-3 href=#__codelineno-35-3></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-35-4 name=__codelineno-35-4 href=#__codelineno-35-4></a>
|
||
<a id=__codelineno-35-5 name=__codelineno-35-5 href=#__codelineno-35-5></a> <span class=k>def</span> <span class=nf>post</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span> <span class=o>-></span> <span class=n>HttpResponse</span><span class=p>:</span>
|
||
<a id=__codelineno-35-6 name=__codelineno-35-6 href=#__codelineno-35-6></a> <span class=n>variable</span> <span class=o>=</span> <span class=n>request</span><span class=o>.</span><span class=n>POST</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s2>"variable"</span><span class=p>)</span>
|
||
<a id=__codelineno-35-7 name=__codelineno-35-7 href=#__codelineno-35-7></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>component</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||
<a id=__codelineno-35-8 name=__codelineno-35-8 href=#__codelineno-35-8></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span><span class=s2>"variable"</span><span class=p>:</span> <span class=n>variable</span><span class=p>}</span>
|
||
<a id=__codelineno-35-9 name=__codelineno-35-9 href=#__codelineno-35-9></a> <span class=p>)</span>
|
||
<a id=__codelineno-35-10 name=__codelineno-35-10 href=#__codelineno-35-10></a>
|
||
<a id=__codelineno-35-11 name=__codelineno-35-11 href=#__codelineno-35-11></a> <span class=k>class</span> <span class=nc>View</span><span class=p>(</span><span class=n>ComponentView</span><span class=p>):</span>
|
||
<a id=__codelineno-35-12 name=__codelineno-35-12 href=#__codelineno-35-12></a> <span class=k>def</span> <span class=nf>setup</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-35-13 name=__codelineno-35-13 href=#__codelineno-35-13></a> <span class=nb>super</span><span class=p>(</span><span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
|
||
<a id=__codelineno-35-14 name=__codelineno-35-14 href=#__codelineno-35-14></a>
|
||
<a id=__codelineno-35-15 name=__codelineno-35-15 href=#__codelineno-35-15></a> <span class=n>do_something_extra</span><span class=p>(</span><span class=n>request</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
|
||
</code></pre></div> <h2 id=typing-and-validating-components>Typing and validating components<a class=headerlink href=#typing-and-validating-components title="Permanent link">¤</a></h2> <h3 id=adding-type-hints-with-generics>Adding type hints with Generics<a class=headerlink href=#adding-type-hints-with-generics title="Permanent link">¤</a></h3> <p><em>New in version 0.92</em></p> <p>The <code>Component</code> class optionally accepts type parameters that allow you to specify the types of args, kwargs, slots, and data:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-36-1 name=__codelineno-36-1 href=#__codelineno-36-1></a><span class=k>class</span> <span class=nc>Button</span><span class=p>(</span><span class=n>Component</span><span class=p>[</span><span class=n>Args</span><span class=p>,</span> <span class=n>Kwargs</span><span class=p>,</span> <span class=n>Slots</span><span class=p>,</span> <span class=n>Data</span><span class=p>,</span> <span class=n>JsData</span><span class=p>,</span> <span class=n>CssData</span><span class=p>]):</span>
|
||
<a id=__codelineno-36-2 name=__codelineno-36-2 href=#__codelineno-36-2></a> <span class=o>...</span>
|
||
</code></pre></div> <ul> <li><code>Args</code> - Must be a <code>Tuple</code> or <code>Any</code></li> <li><code>Kwargs</code> - Must be a <code>TypedDict</code> or <code>Any</code></li> <li><code>Data</code> - Must be a <code>TypedDict</code> or <code>Any</code></li> <li><code>Slots</code> - Must be a <code>TypedDict</code> or <code>Any</code></li> </ul> <p>Here's a full example:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-37-1 name=__codelineno-37-1 href=#__codelineno-37-1></a><span class=kn>from</span> <span class=nn>typing</span> <span class=kn>import</span> <span class=n>NotRequired</span><span class=p>,</span> <span class=n>Tuple</span><span class=p>,</span> <span class=n>TypedDict</span><span class=p>,</span> <span class=n>SlotContent</span><span class=p>,</span> <span class=n>SlotFunc</span>
|
||
<a id=__codelineno-37-2 name=__codelineno-37-2 href=#__codelineno-37-2></a>
|
||
<a id=__codelineno-37-3 name=__codelineno-37-3 href=#__codelineno-37-3></a><span class=c1># Positional inputs</span>
|
||
<a id=__codelineno-37-4 name=__codelineno-37-4 href=#__codelineno-37-4></a><span class=n>Args</span> <span class=o>=</span> <span class=n>Tuple</span><span class=p>[</span><span class=nb>int</span><span class=p>,</span> <span class=nb>str</span><span class=p>]</span>
|
||
<a id=__codelineno-37-5 name=__codelineno-37-5 href=#__codelineno-37-5></a>
|
||
<a id=__codelineno-37-6 name=__codelineno-37-6 href=#__codelineno-37-6></a><span class=c1># Kwargs inputs</span>
|
||
<a id=__codelineno-37-7 name=__codelineno-37-7 href=#__codelineno-37-7></a><span class=k>class</span> <span class=nc>Kwargs</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-37-8 name=__codelineno-37-8 href=#__codelineno-37-8></a> <span class=n>variable</span><span class=p>:</span> <span class=nb>str</span>
|
||
<a id=__codelineno-37-9 name=__codelineno-37-9 href=#__codelineno-37-9></a> <span class=n>another</span><span class=p>:</span> <span class=nb>int</span>
|
||
<a id=__codelineno-37-10 name=__codelineno-37-10 href=#__codelineno-37-10></a> <span class=n>maybe_var</span><span class=p>:</span> <span class=n>NotRequired</span><span class=p>[</span><span class=nb>int</span><span class=p>]</span> <span class=c1># May be ommited</span>
|
||
<a id=__codelineno-37-11 name=__codelineno-37-11 href=#__codelineno-37-11></a>
|
||
<a id=__codelineno-37-12 name=__codelineno-37-12 href=#__codelineno-37-12></a><span class=c1># Data returned from `get_context_data`</span>
|
||
<a id=__codelineno-37-13 name=__codelineno-37-13 href=#__codelineno-37-13></a><span class=k>class</span> <span class=nc>Data</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-37-14 name=__codelineno-37-14 href=#__codelineno-37-14></a> <span class=n>variable</span><span class=p>:</span> <span class=nb>str</span>
|
||
<a id=__codelineno-37-15 name=__codelineno-37-15 href=#__codelineno-37-15></a>
|
||
<a id=__codelineno-37-16 name=__codelineno-37-16 href=#__codelineno-37-16></a><span class=c1># The data available to the `my_slot` scoped slot</span>
|
||
<a id=__codelineno-37-17 name=__codelineno-37-17 href=#__codelineno-37-17></a><span class=k>class</span> <span class=nc>MySlotData</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-37-18 name=__codelineno-37-18 href=#__codelineno-37-18></a> <span class=n>value</span><span class=p>:</span> <span class=nb>int</span>
|
||
<a id=__codelineno-37-19 name=__codelineno-37-19 href=#__codelineno-37-19></a>
|
||
<a id=__codelineno-37-20 name=__codelineno-37-20 href=#__codelineno-37-20></a><span class=c1># Slots</span>
|
||
<a id=__codelineno-37-21 name=__codelineno-37-21 href=#__codelineno-37-21></a><span class=k>class</span> <span class=nc>Slots</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-37-22 name=__codelineno-37-22 href=#__codelineno-37-22></a> <span class=c1># Use SlotFunc for slot functions.</span>
|
||
<a id=__codelineno-37-23 name=__codelineno-37-23 href=#__codelineno-37-23></a> <span class=c1># The generic specifies the `data` dictionary</span>
|
||
<a id=__codelineno-37-24 name=__codelineno-37-24 href=#__codelineno-37-24></a> <span class=n>my_slot</span><span class=p>:</span> <span class=n>NotRequired</span><span class=p>[</span><span class=n>SlotFunc</span><span class=p>[</span><span class=n>MySlotData</span><span class=p>]]</span>
|
||
<a id=__codelineno-37-25 name=__codelineno-37-25 href=#__codelineno-37-25></a> <span class=c1># SlotContent == Union[str, SafeString]</span>
|
||
<a id=__codelineno-37-26 name=__codelineno-37-26 href=#__codelineno-37-26></a> <span class=n>another_slot</span><span class=p>:</span> <span class=n>SlotContent</span>
|
||
<a id=__codelineno-37-27 name=__codelineno-37-27 href=#__codelineno-37-27></a>
|
||
<a id=__codelineno-37-28 name=__codelineno-37-28 href=#__codelineno-37-28></a><span class=k>class</span> <span class=nc>Button</span><span class=p>(</span><span class=n>Component</span><span class=p>[</span><span class=n>Args</span><span class=p>,</span> <span class=n>Kwargs</span><span class=p>,</span> <span class=n>Slots</span><span class=p>,</span> <span class=n>Data</span><span class=p>,</span> <span class=n>JsData</span><span class=p>,</span> <span class=n>CssData</span><span class=p>]):</span>
|
||
<a id=__codelineno-37-29 name=__codelineno-37-29 href=#__codelineno-37-29></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>variable</span><span class=p>,</span> <span class=n>another</span><span class=p>):</span>
|
||
<a id=__codelineno-37-30 name=__codelineno-37-30 href=#__codelineno-37-30></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-37-31 name=__codelineno-37-31 href=#__codelineno-37-31></a> <span class=s2>"variable"</span><span class=p>:</span> <span class=n>variable</span><span class=p>,</span>
|
||
<a id=__codelineno-37-32 name=__codelineno-37-32 href=#__codelineno-37-32></a> <span class=p>}</span>
|
||
</code></pre></div> <p>When you then call <code>Component.render</code> or <code>Component.render_to_response</code>, you will get type hints:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-38-1 name=__codelineno-38-1 href=#__codelineno-38-1></a><span class=n>Button</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-38-2 name=__codelineno-38-2 href=#__codelineno-38-2></a> <span class=c1># Error: First arg must be `int`, got `float`</span>
|
||
<a id=__codelineno-38-3 name=__codelineno-38-3 href=#__codelineno-38-3></a> <span class=n>args</span><span class=o>=</span><span class=p>(</span><span class=mf>1.25</span><span class=p>,</span> <span class=s2>"abc"</span><span class=p>),</span>
|
||
<a id=__codelineno-38-4 name=__codelineno-38-4 href=#__codelineno-38-4></a> <span class=c1># Error: Key "another" is missing</span>
|
||
<a id=__codelineno-38-5 name=__codelineno-38-5 href=#__codelineno-38-5></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span>
|
||
<a id=__codelineno-38-6 name=__codelineno-38-6 href=#__codelineno-38-6></a> <span class=s2>"variable"</span><span class=p>:</span> <span class=s2>"text"</span><span class=p>,</span>
|
||
<a id=__codelineno-38-7 name=__codelineno-38-7 href=#__codelineno-38-7></a> <span class=p>},</span>
|
||
<a id=__codelineno-38-8 name=__codelineno-38-8 href=#__codelineno-38-8></a><span class=p>)</span>
|
||
</code></pre></div> <h4 id=usage-for-python-311>Usage for Python <3.11<a class=headerlink href=#usage-for-python-311 title="Permanent link">¤</a></h4> <p>On Python 3.8-3.10, use <code>typing_extensions</code></p> <div class=highlight><pre><span></span><code><a id=__codelineno-39-1 name=__codelineno-39-1 href=#__codelineno-39-1></a><span class=kn>from</span> <span class=nn>typing_extensions</span> <span class=kn>import</span> <span class=n>TypedDict</span><span class=p>,</span> <span class=n>NotRequired</span>
|
||
</code></pre></div> <p>Additionally on Python 3.8-3.9, also import <code>annotations</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-40-1 name=__codelineno-40-1 href=#__codelineno-40-1></a><span class=kn>from</span> <span class=nn>__future__</span> <span class=kn>import</span> <span class=n>annotations</span>
|
||
</code></pre></div> <p>Moreover, on 3.10 and less, you may not be able to use <code>NotRequired</code>, and instead you will need to mark either all keys are required, or all keys as optional, using TypeDict's <code>total</code> kwarg.</p> <p><a href=https://peps.python.org/pep-0655>See PEP-655</a> for more info.</p> <h3 id=passing-additional-args-or-kwargs>Passing additional args or kwargs<a class=headerlink href=#passing-additional-args-or-kwargs title="Permanent link">¤</a></h3> <p>You may have a function that supports any number of args or kwargs:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-41-1 name=__codelineno-41-1 href=#__codelineno-41-1></a><span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-41-2 name=__codelineno-41-2 href=#__codelineno-41-2></a> <span class=o>...</span>
|
||
</code></pre></div> <p>This is not supported with the typed components.</p> <p>As a workaround: - For <code>*args</code>, set a positional argument that accepts a list of values:</p> <div class=codehilite><pre><span></span><code><span class=err>```</span><span class=n>py</span>
|
||
<span class=err>#</span><span class=w> </span><span class=n>Tuple</span><span class=w> </span><span class=k>of</span><span class=w> </span><span class=n>one</span><span class=w> </span><span class=k>member</span><span class=w> </span><span class=k>of</span><span class=w> </span><span class=n>list</span><span class=w> </span><span class=k>of</span><span class=w> </span><span class=n>strings</span>
|
||
<span class=n>Args</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>Tuple</span><span class=o>[</span><span class=n>List[str</span><span class=o>]</span><span class=err>]</span>
|
||
<span class=err>```</span>
|
||
</code></pre></div> <ul> <li> <p>For <code>*kwargs</code>, set a keyword argument that accepts a dictionary of values:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-43-1 name=__codelineno-43-1 href=#__codelineno-43-1></a><span class=k>class</span> <span class=nc>Kwargs</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-43-2 name=__codelineno-43-2 href=#__codelineno-43-2></a> <span class=n>variable</span><span class=p>:</span> <span class=nb>str</span>
|
||
<a id=__codelineno-43-3 name=__codelineno-43-3 href=#__codelineno-43-3></a> <span class=n>another</span><span class=p>:</span> <span class=nb>int</span>
|
||
<a id=__codelineno-43-4 name=__codelineno-43-4 href=#__codelineno-43-4></a> <span class=c1># Pass any extra keys under `extra`</span>
|
||
<a id=__codelineno-43-5 name=__codelineno-43-5 href=#__codelineno-43-5></a> <span class=n>extra</span><span class=p>:</span> <span class=n>Dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=nb>any</span><span class=p>]</span>
|
||
</code></pre></div> </li> </ul> <h3 id=handling-no-args-or-no-kwargs>Handling no args or no kwargs<a class=headerlink href=#handling-no-args-or-no-kwargs title="Permanent link">¤</a></h3> <p>To declare that a component accepts no Args, Kwargs, etc, you can use <code>EmptyTuple</code> and <code>EmptyDict</code> types:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-44-1 name=__codelineno-44-1 href=#__codelineno-44-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>EmptyDict</span><span class=p>,</span> <span class=n>EmptyTuple</span>
|
||
<a id=__codelineno-44-2 name=__codelineno-44-2 href=#__codelineno-44-2></a>
|
||
<a id=__codelineno-44-3 name=__codelineno-44-3 href=#__codelineno-44-3></a><span class=n>Args</span> <span class=o>=</span> <span class=n>EmptyTuple</span>
|
||
<a id=__codelineno-44-4 name=__codelineno-44-4 href=#__codelineno-44-4></a><span class=n>Kwargs</span> <span class=o>=</span> <span class=n>Data</span> <span class=o>=</span> <span class=n>Slots</span> <span class=o>=</span> <span class=n>EmptyDict</span>
|
||
<a id=__codelineno-44-5 name=__codelineno-44-5 href=#__codelineno-44-5></a>
|
||
<a id=__codelineno-44-6 name=__codelineno-44-6 href=#__codelineno-44-6></a><span class=k>class</span> <span class=nc>Button</span><span class=p>(</span><span class=n>Component</span><span class=p>[</span><span class=n>Args</span><span class=p>,</span> <span class=n>Kwargs</span><span class=p>,</span> <span class=n>Slots</span><span class=p>,</span> <span class=n>Data</span><span class=p>,</span> <span class=n>JsData</span><span class=p>,</span> <span class=n>CssData</span><span class=p>]):</span>
|
||
<a id=__codelineno-44-7 name=__codelineno-44-7 href=#__codelineno-44-7></a> <span class=o>...</span>
|
||
</code></pre></div> <h3 id=runtime-input-validation-with-types>Runtime input validation with types<a class=headerlink href=#runtime-input-validation-with-types title="Permanent link">¤</a></h3> <p><em>New in version 0.96</em></p> <blockquote> <p>NOTE: Kwargs, slots, and data validation is supported only for Python >=3.11</p> </blockquote> <p>In Python 3.11 and later, when you specify the component types, you will get also runtime validation of the inputs you pass to <code>Component.render</code> or <code>Component.render_to_response</code>.</p> <p>So, using the example from before, if you ignored the type errors and still ran the following code:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-45-1 name=__codelineno-45-1 href=#__codelineno-45-1></a><span class=n>Button</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-45-2 name=__codelineno-45-2 href=#__codelineno-45-2></a> <span class=c1># Error: First arg must be `int`, got `float`</span>
|
||
<a id=__codelineno-45-3 name=__codelineno-45-3 href=#__codelineno-45-3></a> <span class=n>args</span><span class=o>=</span><span class=p>(</span><span class=mf>1.25</span><span class=p>,</span> <span class=s2>"abc"</span><span class=p>),</span>
|
||
<a id=__codelineno-45-4 name=__codelineno-45-4 href=#__codelineno-45-4></a> <span class=c1># Error: Key "another" is missing</span>
|
||
<a id=__codelineno-45-5 name=__codelineno-45-5 href=#__codelineno-45-5></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span>
|
||
<a id=__codelineno-45-6 name=__codelineno-45-6 href=#__codelineno-45-6></a> <span class=s2>"variable"</span><span class=p>:</span> <span class=s2>"text"</span><span class=p>,</span>
|
||
<a id=__codelineno-45-7 name=__codelineno-45-7 href=#__codelineno-45-7></a> <span class=p>},</span>
|
||
<a id=__codelineno-45-8 name=__codelineno-45-8 href=#__codelineno-45-8></a><span class=p>)</span>
|
||
</code></pre></div> <p>This would raise a <code>TypeError</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-46-1 name=__codelineno-46-1 href=#__codelineno-46-1></a>Component 'Button' expected positional argument at index 0 to be <class 'int'>, got 1.25 of type <class 'float'>
|
||
</code></pre></div> <p>In case you need to skip these errors, you can either set the faulty member to <code>Any</code>, e.g.:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-47-1 name=__codelineno-47-1 href=#__codelineno-47-1></a><span class=c1># Changed `int` to `Any`</span>
|
||
<a id=__codelineno-47-2 name=__codelineno-47-2 href=#__codelineno-47-2></a><span class=n>Args</span> <span class=o>=</span> <span class=n>Tuple</span><span class=p>[</span><span class=n>Any</span><span class=p>,</span> <span class=nb>str</span><span class=p>]</span>
|
||
</code></pre></div> <p>Or you can replace <code>Args</code> with <code>Any</code> altogether, to skip the validation of args:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-48-1 name=__codelineno-48-1 href=#__codelineno-48-1></a><span class=c1># Replaced `Args` with `Any`</span>
|
||
<a id=__codelineno-48-2 name=__codelineno-48-2 href=#__codelineno-48-2></a><span class=k>class</span> <span class=nc>Button</span><span class=p>(</span><span class=n>Component</span><span class=p>[</span><span class=n>Any</span><span class=p>,</span> <span class=n>Kwargs</span><span class=p>,</span> <span class=n>Slots</span><span class=p>,</span> <span class=n>Data</span><span class=p>,</span> <span class=n>JsData</span><span class=p>,</span> <span class=n>CssData</span><span class=p>]):</span>
|
||
<a id=__codelineno-48-3 name=__codelineno-48-3 href=#__codelineno-48-3></a> <span class=o>...</span>
|
||
</code></pre></div> <p>Same applies to kwargs, data, and slots.</p> <h2 id=pre-defined-components>Pre-defined components<a class=headerlink href=#pre-defined-components title="Permanent link">¤</a></h2> <h3 id=dynamic-components>Dynamic components<a class=headerlink href=#dynamic-components title="Permanent link">¤</a></h3> <p>If you are writing something like a form component, you may design it such that users give you the component names, and your component renders it.</p> <p>While you can handle this with a series of if / else statements, this is not an extensible solution.</p> <p>Instead, you can use <strong>dynamic components</strong>. Dynamic components are used in place of normal components.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-49-1 name=__codelineno-49-1 href=#__codelineno-49-1></a><span class=cp>{%</span> <span class=k>load</span> <span class=nv>component_tags</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-49-2 name=__codelineno-49-2 href=#__codelineno-49-2></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"dynamic"</span> <span class=k>is</span><span class=o>=</span><span class=nv>component_name</span> <span class=nv>title</span><span class=o>=</span><span class=s2>"Cat Museum"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-49-3 name=__codelineno-49-3 href=#__codelineno-49-3></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"content"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-49-4 name=__codelineno-49-4 href=#__codelineno-49-4></a><span class=x> HELLO_FROM_SLOT_1</span>
|
||
<a id=__codelineno-49-5 name=__codelineno-49-5 href=#__codelineno-49-5></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-49-6 name=__codelineno-49-6 href=#__codelineno-49-6></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"sidebar"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-49-7 name=__codelineno-49-7 href=#__codelineno-49-7></a><span class=x> HELLO_FROM_SLOT_2</span>
|
||
<a id=__codelineno-49-8 name=__codelineno-49-8 href=#__codelineno-49-8></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-49-9 name=__codelineno-49-9 href=#__codelineno-49-9></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>or in case you use the <code>django_components.component_shorthand_formatter</code> tag formatter:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-50-1 name=__codelineno-50-1 href=#__codelineno-50-1></a><span class=cp>{%</span> <span class=k>dynamic</span> <span class=k>is</span><span class=o>=</span><span class=nv>component_name</span> <span class=nv>title</span><span class=o>=</span><span class=s2>"Cat Museu"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-50-2 name=__codelineno-50-2 href=#__codelineno-50-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"content"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-50-3 name=__codelineno-50-3 href=#__codelineno-50-3></a><span class=x> HELLO_FROM_SLOT_1</span>
|
||
<a id=__codelineno-50-4 name=__codelineno-50-4 href=#__codelineno-50-4></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-50-5 name=__codelineno-50-5 href=#__codelineno-50-5></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"sidebar"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-50-6 name=__codelineno-50-6 href=#__codelineno-50-6></a><span class=x> HELLO_FROM_SLOT_2</span>
|
||
<a id=__codelineno-50-7 name=__codelineno-50-7 href=#__codelineno-50-7></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-50-8 name=__codelineno-50-8 href=#__codelineno-50-8></a><span class=cp>{%</span> <span class=k>enddynamic</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>These behave same way as regular components. You pass it the same args, kwargs, and slots as you would to the component that you want to render.</p> <p>The only exception is that also you supply 1-2 additional inputs: - <code>is</code> - Required - The component name or a component class to render - <code>registry</code> - Optional - The <code>ComponentRegistry</code> that will be searched if <code>is</code> is a component name. If omitted, ALL registries are searched.</p> <p>By default, the dynamic component is registered under the name <code>"dynamic"</code>. In case of a conflict, you can change the name used for the dynamic components by defining the <a href=#dynamic_component_name><code>COMPONENTS.dynamic_component_name</code> setting</a>.</p> <p>If you need to use the dynamic components in Python, you can also import it from <code>django_components</code>: <div class=highlight><pre><span></span><code><a id=__codelineno-51-1 name=__codelineno-51-1 href=#__codelineno-51-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>DynamicComponent</span>
|
||
<a id=__codelineno-51-2 name=__codelineno-51-2 href=#__codelineno-51-2></a>
|
||
<a id=__codelineno-51-3 name=__codelineno-51-3 href=#__codelineno-51-3></a><span class=n>comp</span> <span class=o>=</span> <span class=n>SimpleTableComp</span> <span class=k>if</span> <span class=n>is_readonly</span> <span class=k>else</span> <span class=n>TableComp</span>
|
||
<a id=__codelineno-51-4 name=__codelineno-51-4 href=#__codelineno-51-4></a>
|
||
<a id=__codelineno-51-5 name=__codelineno-51-5 href=#__codelineno-51-5></a><span class=n>output</span> <span class=o>=</span> <span class=n>DynamicComponent</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-51-6 name=__codelineno-51-6 href=#__codelineno-51-6></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span>
|
||
<a id=__codelineno-51-7 name=__codelineno-51-7 href=#__codelineno-51-7></a> <span class=s2>"is"</span><span class=p>:</span> <span class=n>comp</span><span class=p>,</span>
|
||
<a id=__codelineno-51-8 name=__codelineno-51-8 href=#__codelineno-51-8></a> <span class=c1># Other kwargs...</span>
|
||
<a id=__codelineno-51-9 name=__codelineno-51-9 href=#__codelineno-51-9></a> <span class=p>},</span>
|
||
<a id=__codelineno-51-10 name=__codelineno-51-10 href=#__codelineno-51-10></a> <span class=c1># args: [...],</span>
|
||
<a id=__codelineno-51-11 name=__codelineno-51-11 href=#__codelineno-51-11></a> <span class=c1># slots: {...},</span>
|
||
<a id=__codelineno-51-12 name=__codelineno-51-12 href=#__codelineno-51-12></a><span class=p>)</span>
|
||
</code></pre></div></p> <h2 id=registering-components>Registering components<a class=headerlink href=#registering-components title="Permanent link">¤</a></h2> <p>In previous examples you could repeatedly see us using <code>@register()</code> to "register" the components. In this section we dive deeper into what it actually means and how you can manage (add or remove) components.</p> <p>As a reminder, we may have a component like this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-52-1 name=__codelineno-52-1 href=#__codelineno-52-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-52-2 name=__codelineno-52-2 href=#__codelineno-52-2></a>
|
||
<a id=__codelineno-52-3 name=__codelineno-52-3 href=#__codelineno-52-3></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-52-4 name=__codelineno-52-4 href=#__codelineno-52-4></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-52-5 name=__codelineno-52-5 href=#__codelineno-52-5></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"template.html"</span>
|
||
<a id=__codelineno-52-6 name=__codelineno-52-6 href=#__codelineno-52-6></a>
|
||
<a id=__codelineno-52-7 name=__codelineno-52-7 href=#__codelineno-52-7></a> <span class=c1># This component takes one parameter, a date string to show in the template</span>
|
||
<a id=__codelineno-52-8 name=__codelineno-52-8 href=#__codelineno-52-8></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>):</span>
|
||
<a id=__codelineno-52-9 name=__codelineno-52-9 href=#__codelineno-52-9></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-52-10 name=__codelineno-52-10 href=#__codelineno-52-10></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
||
<a id=__codelineno-52-11 name=__codelineno-52-11 href=#__codelineno-52-11></a> <span class=p>}</span>
|
||
</code></pre></div> <p>which we then render in the template as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-53-1 name=__codelineno-53-1 href=#__codelineno-53-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"1970-01-01"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-53-2 name=__codelineno-53-2 href=#__codelineno-53-2></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>As you can see, <code>@register</code> links up the component class with the <code>{% component %}</code> template tag. So when the template tag comes across a component called <code>"calendar"</code>, it can look up it's class and instantiate it.</p> <h3 id=what-is-componentregistry>What is ComponentRegistry<a class=headerlink href=#what-is-componentregistry title="Permanent link">¤</a></h3> <p>The <code>@register</code> decorator is a shortcut for working with the <code>ComponentRegistry</code>.</p> <p><code>ComponentRegistry</code> manages which components can be used in the template tags.</p> <p>Each <code>ComponentRegistry</code> instance is associated with an instance of Django's <code>Library</code>. And Libraries are inserted into Django template using the <code>{% load %}</code> tags.</p> <p>The <code>@register</code> decorator accepts an optional kwarg <code>registry</code>, which specifies, the <code>ComponentRegistry</code> to register components into. If omitted, the default <code>ComponentRegistry</code> instance defined in django_components is used.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-54-1 name=__codelineno-54-1 href=#__codelineno-54-1></a><span class=n>my_registry</span> <span class=o>=</span> <span class=n>ComponentRegistry</span><span class=p>()</span>
|
||
<a id=__codelineno-54-2 name=__codelineno-54-2 href=#__codelineno-54-2></a>
|
||
<a id=__codelineno-54-3 name=__codelineno-54-3 href=#__codelineno-54-3></a><span class=nd>@register</span><span class=p>(</span><span class=n>registry</span><span class=o>=</span><span class=n>my_registry</span><span class=p>)</span>
|
||
<a id=__codelineno-54-4 name=__codelineno-54-4 href=#__codelineno-54-4></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-54-5 name=__codelineno-54-5 href=#__codelineno-54-5></a> <span class=o>...</span>
|
||
</code></pre></div> <p>The default <code>ComponentRegistry</code> is associated with the <code>Library</code> that you load when you call <code>{% load component_tags %}</code> inside your template, or when you add <code>django_components.templatetags.component_tags</code> to the template builtins.</p> <p>So when you register or unregister a component to/from a component registry, then behind the scenes the registry automatically adds/removes the component's template tags to/from the Library, so you can call the component from within the templates such as <code>{% component "my_comp" %}</code>.</p> <h3 id=working-with-componentregistry>Working with ComponentRegistry<a class=headerlink href=#working-with-componentregistry title="Permanent link">¤</a></h3> <p>The default <code>ComponentRegistry</code> instance can be imported as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-55-1 name=__codelineno-55-1 href=#__codelineno-55-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>registry</span>
|
||
</code></pre></div> <p>You can use the registry to manually add/remove/get components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-56-1 name=__codelineno-56-1 href=#__codelineno-56-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>registry</span>
|
||
<a id=__codelineno-56-2 name=__codelineno-56-2 href=#__codelineno-56-2></a>
|
||
<a id=__codelineno-56-3 name=__codelineno-56-3 href=#__codelineno-56-3></a><span class=c1># Register components</span>
|
||
<a id=__codelineno-56-4 name=__codelineno-56-4 href=#__codelineno-56-4></a><span class=n>registry</span><span class=o>.</span><span class=n>register</span><span class=p>(</span><span class=s2>"button"</span><span class=p>,</span> <span class=n>ButtonComponent</span><span class=p>)</span>
|
||
<a id=__codelineno-56-5 name=__codelineno-56-5 href=#__codelineno-56-5></a><span class=n>registry</span><span class=o>.</span><span class=n>register</span><span class=p>(</span><span class=s2>"card"</span><span class=p>,</span> <span class=n>CardComponent</span><span class=p>)</span>
|
||
<a id=__codelineno-56-6 name=__codelineno-56-6 href=#__codelineno-56-6></a>
|
||
<a id=__codelineno-56-7 name=__codelineno-56-7 href=#__codelineno-56-7></a><span class=c1># Get all or single</span>
|
||
<a id=__codelineno-56-8 name=__codelineno-56-8 href=#__codelineno-56-8></a><span class=n>registry</span><span class=o>.</span><span class=n>all</span><span class=p>()</span> <span class=c1># {"button": ButtonComponent, "card": CardComponent}</span>
|
||
<a id=__codelineno-56-9 name=__codelineno-56-9 href=#__codelineno-56-9></a><span class=n>registry</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s2>"card"</span><span class=p>)</span> <span class=c1># CardComponent</span>
|
||
<a id=__codelineno-56-10 name=__codelineno-56-10 href=#__codelineno-56-10></a>
|
||
<a id=__codelineno-56-11 name=__codelineno-56-11 href=#__codelineno-56-11></a><span class=c1># Unregister single component</span>
|
||
<a id=__codelineno-56-12 name=__codelineno-56-12 href=#__codelineno-56-12></a><span class=n>registry</span><span class=o>.</span><span class=n>unregister</span><span class=p>(</span><span class=s2>"card"</span><span class=p>)</span>
|
||
<a id=__codelineno-56-13 name=__codelineno-56-13 href=#__codelineno-56-13></a>
|
||
<a id=__codelineno-56-14 name=__codelineno-56-14 href=#__codelineno-56-14></a><span class=c1># Unregister all components</span>
|
||
<a id=__codelineno-56-15 name=__codelineno-56-15 href=#__codelineno-56-15></a><span class=n>registry</span><span class=o>.</span><span class=n>clear</span><span class=p>()</span>
|
||
</code></pre></div> <h3 id=registering-components-to-custom-componentregistry>Registering components to custom ComponentRegistry<a class=headerlink href=#registering-components-to-custom-componentregistry title="Permanent link">¤</a></h3> <p>If you are writing a component library to be shared with others, you may want to manage your own instance of <code>ComponentRegistry</code> and register components onto a different <code>Library</code> instance than the default one.</p> <p>The <code>Library</code> instance can be set at instantiation of <code>ComponentRegistry</code>. If omitted, then the default Library instance from django_components is used.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-57-1 name=__codelineno-57-1 href=#__codelineno-57-1></a><span class=kn>from</span> <span class=nn>django.template</span> <span class=kn>import</span> <span class=n>Library</span>
|
||
<a id=__codelineno-57-2 name=__codelineno-57-2 href=#__codelineno-57-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>ComponentRegistry</span>
|
||
<a id=__codelineno-57-3 name=__codelineno-57-3 href=#__codelineno-57-3></a>
|
||
<a id=__codelineno-57-4 name=__codelineno-57-4 href=#__codelineno-57-4></a><span class=n>my_library</span> <span class=o>=</span> <span class=n>Library</span><span class=p>(</span><span class=o>...</span><span class=p>)</span>
|
||
<a id=__codelineno-57-5 name=__codelineno-57-5 href=#__codelineno-57-5></a><span class=n>my_registry</span> <span class=o>=</span> <span class=n>ComponentRegistry</span><span class=p>(</span><span class=n>library</span><span class=o>=</span><span class=n>my_library</span><span class=p>)</span>
|
||
</code></pre></div> <p>When you have defined your own <code>ComponentRegistry</code>, you can either register the components with <code>my_registry.register()</code>, or pass the registry to the <code>@component.register()</code> decorator via the <code>registry</code> kwarg:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-58-1 name=__codelineno-58-1 href=#__codelineno-58-1></a><span class=kn>from</span> <span class=nn>path.to.my.registry</span> <span class=kn>import</span> <span class=n>my_registry</span>
|
||
<a id=__codelineno-58-2 name=__codelineno-58-2 href=#__codelineno-58-2></a>
|
||
<a id=__codelineno-58-3 name=__codelineno-58-3 href=#__codelineno-58-3></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_component"</span><span class=p>,</span> <span class=n>registry</span><span class=o>=</span><span class=n>my_registry</span><span class=p>)</span>
|
||
<a id=__codelineno-58-4 name=__codelineno-58-4 href=#__codelineno-58-4></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-58-5 name=__codelineno-58-5 href=#__codelineno-58-5></a> <span class=o>...</span>
|
||
</code></pre></div> <p>NOTE: The Library instance can be accessed under <code>library</code> attribute of <code>ComponentRegistry</code>.</p> <h3 id=componentregistry-settings>ComponentRegistry settings<a class=headerlink href=#componentregistry-settings title="Permanent link">¤</a></h3> <p>When you are creating an instance of <code>ComponentRegistry</code>, you can define the components' behavior within the template.</p> <p>The registry accepts these settings: - <code>context_behavior</code> - <code>tag_formatter</code></p> <div class=highlight><pre><span></span><code><a id=__codelineno-59-1 name=__codelineno-59-1 href=#__codelineno-59-1></a><span class=kn>from</span> <span class=nn>django.template</span> <span class=kn>import</span> <span class=n>Library</span>
|
||
<a id=__codelineno-59-2 name=__codelineno-59-2 href=#__codelineno-59-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>ComponentRegistry</span><span class=p>,</span> <span class=n>RegistrySettings</span>
|
||
<a id=__codelineno-59-3 name=__codelineno-59-3 href=#__codelineno-59-3></a>
|
||
<a id=__codelineno-59-4 name=__codelineno-59-4 href=#__codelineno-59-4></a><span class=n>register</span> <span class=o>=</span> <span class=n>library</span> <span class=o>=</span> <span class=n>django</span><span class=o>.</span><span class=n>template</span><span class=o>.</span><span class=n>Library</span><span class=p>()</span>
|
||
<a id=__codelineno-59-5 name=__codelineno-59-5 href=#__codelineno-59-5></a><span class=n>comp_registry</span> <span class=o>=</span> <span class=n>ComponentRegistry</span><span class=p>(</span>
|
||
<a id=__codelineno-59-6 name=__codelineno-59-6 href=#__codelineno-59-6></a> <span class=n>library</span><span class=o>=</span><span class=n>library</span><span class=p>,</span>
|
||
<a id=__codelineno-59-7 name=__codelineno-59-7 href=#__codelineno-59-7></a> <span class=n>settings</span><span class=o>=</span><span class=n>RegistrySettings</span><span class=p>(</span>
|
||
<a id=__codelineno-59-8 name=__codelineno-59-8 href=#__codelineno-59-8></a> <span class=n>context_behavior</span><span class=o>=</span><span class=s2>"isolated"</span><span class=p>,</span>
|
||
<a id=__codelineno-59-9 name=__codelineno-59-9 href=#__codelineno-59-9></a> <span class=n>tag_formatter</span><span class=o>=</span><span class=s2>"django_components.component_formatter"</span><span class=p>,</span>
|
||
<a id=__codelineno-59-10 name=__codelineno-59-10 href=#__codelineno-59-10></a> <span class=p>),</span>
|
||
<a id=__codelineno-59-11 name=__codelineno-59-11 href=#__codelineno-59-11></a><span class=p>)</span>
|
||
</code></pre></div> <p>These settings are <a href=#available-settings>the same as the ones you can set for django_components</a>.</p> <p>In fact, when you set <code>COMPONENT.tag_formatter</code> or <code>COMPONENT.context_behavior</code>, these are forwarded to the default <code>ComponentRegistry</code>.</p> <p>This makes it possible to have multiple registries with different settings in one projects, and makes sharing of component libraries possible.</p> <h2 id=autodiscovery>Autodiscovery<a class=headerlink href=#autodiscovery title="Permanent link">¤</a></h2> <p>Every component that you want to use in the template with the <code>{% component %}</code> tag needs to be registered with the ComponentRegistry. Normally, we use the <code>@register</code> decorator for that:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-60-1 name=__codelineno-60-1 href=#__codelineno-60-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-60-2 name=__codelineno-60-2 href=#__codelineno-60-2></a>
|
||
<a id=__codelineno-60-3 name=__codelineno-60-3 href=#__codelineno-60-3></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-60-4 name=__codelineno-60-4 href=#__codelineno-60-4></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-60-5 name=__codelineno-60-5 href=#__codelineno-60-5></a> <span class=o>...</span>
|
||
</code></pre></div> <p>But for the component to be registered, the code needs to be executed - the file needs to be imported as a module.</p> <p>One way to do that is by importing all your components in <code>apps.py</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-61-1 name=__codelineno-61-1 href=#__codelineno-61-1></a><span class=kn>from</span> <span class=nn>django.apps</span> <span class=kn>import</span> <span class=n>AppConfig</span>
|
||
<a id=__codelineno-61-2 name=__codelineno-61-2 href=#__codelineno-61-2></a>
|
||
<a id=__codelineno-61-3 name=__codelineno-61-3 href=#__codelineno-61-3></a><span class=k>class</span> <span class=nc>MyAppConfig</span><span class=p>(</span><span class=n>AppConfig</span><span class=p>):</span>
|
||
<a id=__codelineno-61-4 name=__codelineno-61-4 href=#__codelineno-61-4></a> <span class=n>name</span> <span class=o>=</span> <span class=s2>"my_app"</span>
|
||
<a id=__codelineno-61-5 name=__codelineno-61-5 href=#__codelineno-61-5></a>
|
||
<a id=__codelineno-61-6 name=__codelineno-61-6 href=#__codelineno-61-6></a> <span class=k>def</span> <span class=nf>ready</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||
<a id=__codelineno-61-7 name=__codelineno-61-7 href=#__codelineno-61-7></a> <span class=kn>from</span> <span class=nn>components.card.card</span> <span class=kn>import</span> <span class=n>Card</span>
|
||
<a id=__codelineno-61-8 name=__codelineno-61-8 href=#__codelineno-61-8></a> <span class=kn>from</span> <span class=nn>components.list.list</span> <span class=kn>import</span> <span class=n>List</span>
|
||
<a id=__codelineno-61-9 name=__codelineno-61-9 href=#__codelineno-61-9></a> <span class=kn>from</span> <span class=nn>components.menu.menu</span> <span class=kn>import</span> <span class=n>Menu</span>
|
||
<a id=__codelineno-61-10 name=__codelineno-61-10 href=#__codelineno-61-10></a> <span class=kn>from</span> <span class=nn>components.button.button</span> <span class=kn>import</span> <span class=n>Button</span>
|
||
<a id=__codelineno-61-11 name=__codelineno-61-11 href=#__codelineno-61-11></a> <span class=o>...</span>
|
||
</code></pre></div> <p>However, there's a simpler way!</p> <p>By default, the Python files in the <code>COMPONENTS.dirs</code> directories (or app-level <code>[app]/components/</code>) are auto-imported in order to auto-register the components.</p> <p>Autodiscovery occurs when Django is loaded, during the <code>ready</code> hook of the <code>apps.py</code> file.</p> <p>If you are using autodiscovery, keep a few points in mind:</p> <ul> <li>Avoid defining any logic on the module-level inside the <code>components</code> dir, that you would not want to run anyway.</li> <li>Components inside the auto-imported files still need to be registered with <code>@register()</code></li> <li>Auto-imported component files must be valid Python modules, they must use suffix <code>.py</code>, and module name should follow <a href=https://peps.python.org/pep-0008/#package-and-module-names>PEP-8</a>.</li> </ul> <p>Autodiscovery can be disabled in the <a href=#autodiscover---toggle-autodiscovery>settings</a>.</p> <h3 id=manually-trigger-autodiscovery>Manually trigger autodiscovery<a class=headerlink href=#manually-trigger-autodiscovery title="Permanent link">¤</a></h3> <p>Autodiscovery can be also triggered manually as a function call. This is useful if you want to run autodiscovery at a custom point of the lifecycle:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-62-1 name=__codelineno-62-1 href=#__codelineno-62-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>autodiscover</span>
|
||
<a id=__codelineno-62-2 name=__codelineno-62-2 href=#__codelineno-62-2></a>
|
||
<a id=__codelineno-62-3 name=__codelineno-62-3 href=#__codelineno-62-3></a><span class=n>autodiscover</span><span class=p>()</span>
|
||
</code></pre></div> <h2 id=using-slots-in-templates>Using slots in templates<a class=headerlink href=#using-slots-in-templates title="Permanent link">¤</a></h2> <p><em>New in version 0.26</em>:</p> <ul> <li>The <code>slot</code> tag now serves only to declare new slots inside the component template.</li> <li>To override the content of a declared slot, use the newly introduced <code>fill</code> tag instead.</li> <li>Whereas unfilled slots used to raise a warning, filling a slot is now optional by default.</li> <li>To indicate that a slot must be filled, the new <code>required</code> option should be added at the end of the <code>slot</code> tag.</li> </ul> <hr> <p>Components support something called 'slots'. When a component is used inside another template, slots allow the parent template to override specific parts of the child component by passing in different content. This mechanism makes components more reusable and composable. This behavior is similar to <a href=https://vuejs.org/guide/components/slots.html>slots in Vue</a>.</p> <p>In the example below we introduce two block tags that work hand in hand to make this work. These are...</p> <ul> <li><code>{% slot <name> %}</code>/<code>{% endslot %}</code>: Declares a new slot in the component template.</li> <li><code>{% fill <name> %}</code>/<code>{% endfill %}</code>: (Used inside a <code>{% component %}</code> tag pair.) Fills a declared slot with the specified content.</li> </ul> <p>Let's update our calendar component to support more customization. We'll add <code>slot</code> tag pairs to its template, <em>template.html</em>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-63-1 name=__codelineno-63-1 href=#__codelineno-63-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-63-2 name=__codelineno-63-2 href=#__codelineno-63-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-63-3 name=__codelineno-63-3 href=#__codelineno-63-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"header"</span> <span class=cp>%}</span>Calendar header<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-63-4 name=__codelineno-63-4 href=#__codelineno-63-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-63-5 name=__codelineno-63-5 href=#__codelineno-63-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-63-6 name=__codelineno-63-6 href=#__codelineno-63-6></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"body"</span> <span class=cp>%}</span>Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span><span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-63-7 name=__codelineno-63-7 href=#__codelineno-63-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-63-8 name=__codelineno-63-8 href=#__codelineno-63-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>When using the component, you specify which slots you want to fill and where you want to use the defaults from the template. It looks like this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-64-1 name=__codelineno-64-1 href=#__codelineno-64-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-64-2 name=__codelineno-64-2 href=#__codelineno-64-2></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"body"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-64-3 name=__codelineno-64-3 href=#__codelineno-64-3></a> Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span>??
|
||
<a id=__codelineno-64-4 name=__codelineno-64-4 href=#__codelineno-64-4></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-64-5 name=__codelineno-64-5 href=#__codelineno-64-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Since the 'header' fill is unspecified, it's taken from the base template. If you put this in a template, and pass in <code>date=2020-06-06</code>, this is what gets rendered:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-65-1 name=__codelineno-65-1 href=#__codelineno-65-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-65-2 name=__codelineno-65-2 href=#__codelineno-65-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-65-3 name=__codelineno-65-3 href=#__codelineno-65-3></a> Calendar header
|
||
<a id=__codelineno-65-4 name=__codelineno-65-4 href=#__codelineno-65-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-65-5 name=__codelineno-65-5 href=#__codelineno-65-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-65-6 name=__codelineno-65-6 href=#__codelineno-65-6></a> Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span>2020-06-06<span class=p></</span><span class=nt>span</span><span class=p>></span>??
|
||
<a id=__codelineno-65-7 name=__codelineno-65-7 href=#__codelineno-65-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-65-8 name=__codelineno-65-8 href=#__codelineno-65-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h3 id=named-slots>Named slots<a class=headerlink href=#named-slots title="Permanent link">¤</a></h3> <p>As seen in the previouse section, you can use <code>{% fill slot_name %}</code> to insert content into a specific slot.</p> <p>You can define fills for multiple slot simply by defining them all within the <code>{% component %} {% endcomponent %}</code> tags:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-66-1 name=__codelineno-66-1 href=#__codelineno-66-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-66-2 name=__codelineno-66-2 href=#__codelineno-66-2></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"header"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-66-3 name=__codelineno-66-3 href=#__codelineno-66-3></a> Hi this is header!
|
||
<a id=__codelineno-66-4 name=__codelineno-66-4 href=#__codelineno-66-4></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-66-5 name=__codelineno-66-5 href=#__codelineno-66-5></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"body"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-66-6 name=__codelineno-66-6 href=#__codelineno-66-6></a> Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span>??
|
||
<a id=__codelineno-66-7 name=__codelineno-66-7 href=#__codelineno-66-7></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-66-8 name=__codelineno-66-8 href=#__codelineno-66-8></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>You can also use <code>{% for %}</code>, <code>{% with %}</code>, or other non-component tags (even <code>{% include %}</code>) to construct the <code>{% fill %}</code> tags, <strong>as long as these other tags do not leave any text behind!</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-67-1 name=__codelineno-67-1 href=#__codelineno-67-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"table"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-2 name=__codelineno-67-2 href=#__codelineno-67-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>for</span> <span class=nv>slot_name</span> <span class=k>in</span> <span class=nv>slots</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-3 name=__codelineno-67-3 href=#__codelineno-67-3></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=nv>name</span><span class=o>=</span><span class=nv>slot_name</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-4 name=__codelineno-67-4 href=#__codelineno-67-4></a><span class=x> </span><span class=cp>{{</span> <span class=nv>slot_name</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-67-5 name=__codelineno-67-5 href=#__codelineno-67-5></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-6 name=__codelineno-67-6 href=#__codelineno-67-6></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfor</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-7 name=__codelineno-67-7 href=#__codelineno-67-7></a>
|
||
<a id=__codelineno-67-8 name=__codelineno-67-8 href=#__codelineno-67-8></a><span class=x> </span><span class=cp>{%</span> <span class=k>with</span> <span class=nv>slot_name</span><span class=o>=</span><span class=s2>"abc"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-9 name=__codelineno-67-9 href=#__codelineno-67-9></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=nv>name</span><span class=o>=</span><span class=nv>slot_name</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-10 name=__codelineno-67-10 href=#__codelineno-67-10></a><span class=x> </span><span class=cp>{{</span> <span class=nv>slot_name</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-67-11 name=__codelineno-67-11 href=#__codelineno-67-11></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-12 name=__codelineno-67-12 href=#__codelineno-67-12></a><span class=x> </span><span class=cp>{%</span> <span class=k>endwith</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-67-13 name=__codelineno-67-13 href=#__codelineno-67-13></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h3 id=default-slot>Default slot<a class=headerlink href=#default-slot title="Permanent link">¤</a></h3> <p><em>Added in version 0.28</em></p> <p>As you can see, component slots lets you write reusable containers that you fill in when you use a component. This makes for highly reusable components that can be used in different circumstances.</p> <p>It can become tedious to use <code>fill</code> tags everywhere, especially when you're using a component that declares only one slot. To make things easier, <code>slot</code> tags can be marked with an optional keyword: <code>default</code>.</p> <p>When added to the tag (as shown below), this option lets you pass filling content directly in the body of a <code>component</code> tag pair – without using a <code>fill</code> tag. Choose carefully, though: a component template may contain at most one slot that is marked as <code>default</code>. The <code>default</code> option can be combined with other slot options, e.g. <code>required</code>.</p> <p>Here's the same example as before, except with default slots and implicit filling.</p> <p>The template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-68-1 name=__codelineno-68-1 href=#__codelineno-68-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-68-2 name=__codelineno-68-2 href=#__codelineno-68-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-68-3 name=__codelineno-68-3 href=#__codelineno-68-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"header"</span> <span class=cp>%}</span>Calendar header<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-68-4 name=__codelineno-68-4 href=#__codelineno-68-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-68-5 name=__codelineno-68-5 href=#__codelineno-68-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-68-6 name=__codelineno-68-6 href=#__codelineno-68-6></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"body"</span> <span class=nv>default</span> <span class=cp>%}</span>Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span><span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-68-7 name=__codelineno-68-7 href=#__codelineno-68-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-68-8 name=__codelineno-68-8 href=#__codelineno-68-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Including the component (notice how the <code>fill</code> tag is omitted):</p> <div class=highlight><pre><span></span><code><a id=__codelineno-69-1 name=__codelineno-69-1 href=#__codelineno-69-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-69-2 name=__codelineno-69-2 href=#__codelineno-69-2></a> Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span>??
|
||
<a id=__codelineno-69-3 name=__codelineno-69-3 href=#__codelineno-69-3></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>The rendered result (exactly the same as before):</p> <div class=highlight><pre><span></span><code><a id=__codelineno-70-1 name=__codelineno-70-1 href=#__codelineno-70-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-70-2 name=__codelineno-70-2 href=#__codelineno-70-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>Calendar header<span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-70-3 name=__codelineno-70-3 href=#__codelineno-70-3></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span>2020-06-06<span class=p></</span><span class=nt>span</span><span class=p>></span>??<span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-70-4 name=__codelineno-70-4 href=#__codelineno-70-4></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>You may be tempted to combine implicit fills with explicit <code>fill</code> tags. This will not work. The following component template will raise an error when rendered.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-71-1 name=__codelineno-71-1 href=#__codelineno-71-1></a><span class=c>{# DON'T DO THIS #}</span>
|
||
<a id=__codelineno-71-2 name=__codelineno-71-2 href=#__codelineno-71-2></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-71-3 name=__codelineno-71-3 href=#__codelineno-71-3></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"header"</span> <span class=cp>%}</span>Totally new header!<span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-71-4 name=__codelineno-71-4 href=#__codelineno-71-4></a> Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span>??
|
||
<a id=__codelineno-71-5 name=__codelineno-71-5 href=#__codelineno-71-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Instead, you can use a named fill with name <code>default</code> to target the default fill:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-72-1 name=__codelineno-72-1 href=#__codelineno-72-1></a><span class=c>{# THIS WORKS #}</span>
|
||
<a id=__codelineno-72-2 name=__codelineno-72-2 href=#__codelineno-72-2></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-72-3 name=__codelineno-72-3 href=#__codelineno-72-3></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"header"</span> <span class=cp>%}</span>Totally new header!<span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-72-4 name=__codelineno-72-4 href=#__codelineno-72-4></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"default"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-72-5 name=__codelineno-72-5 href=#__codelineno-72-5></a> Can you believe it's already <span class=p><</span><span class=nt>span</span><span class=p>></span><span class=cp>{{</span> <span class=nv>date</span> <span class=cp>}}</span><span class=p></</span><span class=nt>span</span><span class=p>></span>??
|
||
<a id=__codelineno-72-6 name=__codelineno-72-6 href=#__codelineno-72-6></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-72-7 name=__codelineno-72-7 href=#__codelineno-72-7></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>NOTE: If you doubly-fill a slot, that is, that both <code>{% fill "default" %}</code> and <code>{% fill "header" %}</code> would point to the same slot, this will raise an error when rendered.</p> <h4 id=accessing-default-slot-in-python>Accessing default slot in Python<a class=headerlink href=#accessing-default-slot-in-python title="Permanent link">¤</a></h4> <p>Since the default slot is stored under the slot name <code>default</code>, you can access the default slot like so:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-73-1 name=__codelineno-73-1 href=#__codelineno-73-1></a><span class=k>class</span> <span class=nc>MyTable</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-73-2 name=__codelineno-73-2 href=#__codelineno-73-2></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-73-3 name=__codelineno-73-3 href=#__codelineno-73-3></a> <span class=n>default_slot</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>slots</span><span class=p>[</span><span class=s2>"default"</span><span class=p>]</span>
|
||
<a id=__codelineno-73-4 name=__codelineno-73-4 href=#__codelineno-73-4></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-73-5 name=__codelineno-73-5 href=#__codelineno-73-5></a> <span class=s2>"default_slot"</span><span class=p>:</span> <span class=n>default_slot</span><span class=p>,</span>
|
||
<a id=__codelineno-73-6 name=__codelineno-73-6 href=#__codelineno-73-6></a> <span class=p>}</span>
|
||
</code></pre></div> <h3 id=render-fill-in-multiple-places>Render fill in multiple places<a class=headerlink href=#render-fill-in-multiple-places title="Permanent link">¤</a></h3> <p><em>Added in version 0.70</em></p> <p>You can render the same content in multiple places by defining multiple slots with identical names:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-74-1 name=__codelineno-74-1 href=#__codelineno-74-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-74-2 name=__codelineno-74-2 href=#__codelineno-74-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-74-3 name=__codelineno-74-3 href=#__codelineno-74-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=cp>%}</span>Image here<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-74-4 name=__codelineno-74-4 href=#__codelineno-74-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-74-5 name=__codelineno-74-5 href=#__codelineno-74-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-74-6 name=__codelineno-74-6 href=#__codelineno-74-6></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=cp>%}</span>Image here<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-74-7 name=__codelineno-74-7 href=#__codelineno-74-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-74-8 name=__codelineno-74-8 href=#__codelineno-74-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>So if used like:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-75-1 name=__codelineno-75-1 href=#__codelineno-75-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-75-2 name=__codelineno-75-2 href=#__codelineno-75-2></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"image"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-75-3 name=__codelineno-75-3 href=#__codelineno-75-3></a> <span class=p><</span><span class=nt>img</span> <span class=na>src</span><span class=o>=</span><span class=s>"..."</span> <span class=p>/></span>
|
||
<a id=__codelineno-75-4 name=__codelineno-75-4 href=#__codelineno-75-4></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-75-5 name=__codelineno-75-5 href=#__codelineno-75-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>This renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-76-1 name=__codelineno-76-1 href=#__codelineno-76-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-76-2 name=__codelineno-76-2 href=#__codelineno-76-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-76-3 name=__codelineno-76-3 href=#__codelineno-76-3></a> <span class=p><</span><span class=nt>img</span> <span class=na>src</span><span class=o>=</span><span class=s>"..."</span> <span class=p>/></span>
|
||
<a id=__codelineno-76-4 name=__codelineno-76-4 href=#__codelineno-76-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-76-5 name=__codelineno-76-5 href=#__codelineno-76-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-76-6 name=__codelineno-76-6 href=#__codelineno-76-6></a> <span class=p><</span><span class=nt>img</span> <span class=na>src</span><span class=o>=</span><span class=s>"..."</span> <span class=p>/></span>
|
||
<a id=__codelineno-76-7 name=__codelineno-76-7 href=#__codelineno-76-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-76-8 name=__codelineno-76-8 href=#__codelineno-76-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h4 id=default-and-required-slots>Default and required slots<a class=headerlink href=#default-and-required-slots title="Permanent link">¤</a></h4> <p>If you use a slot multiple times, you can still mark the slot as <code>default</code> or <code>required</code>. For that, you must mark each slot individually, e.g.:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-77-1 name=__codelineno-77-1 href=#__codelineno-77-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-77-2 name=__codelineno-77-2 href=#__codelineno-77-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-77-3 name=__codelineno-77-3 href=#__codelineno-77-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=nv>default</span> <span class=nv>required</span> <span class=cp>%}</span>Image here<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-77-4 name=__codelineno-77-4 href=#__codelineno-77-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-77-5 name=__codelineno-77-5 href=#__codelineno-77-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-77-6 name=__codelineno-77-6 href=#__codelineno-77-6></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=nv>default</span> <span class=nv>required</span> <span class=cp>%}</span>Image here<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-77-7 name=__codelineno-77-7 href=#__codelineno-77-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-77-8 name=__codelineno-77-8 href=#__codelineno-77-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Which you can then use as regular default slot:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-78-1 name=__codelineno-78-1 href=#__codelineno-78-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-78-2 name=__codelineno-78-2 href=#__codelineno-78-2></a> <span class=p><</span><span class=nt>img</span> <span class=na>src</span><span class=o>=</span><span class=s>"..."</span> <span class=p>/></span>
|
||
<a id=__codelineno-78-3 name=__codelineno-78-3 href=#__codelineno-78-3></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Since each slot is tagged individually, you can have multiple slots with the same name but different conditions.</p> <p>E.g. in this example, we have a component that renders a user avatar - a small circular image with a profile picture of name initials.</p> <p>If the component is given <code>image_src</code> or <code>name_initials</code> variables, the <code>image</code> slot is optional. But if neither of those are provided, you MUST fill the <code>image</code> slot.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-79-1 name=__codelineno-79-1 href=#__codelineno-79-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"avatar"</span><span class=p>></span>
|
||
<a id=__codelineno-79-2 name=__codelineno-79-2 href=#__codelineno-79-2></a> <span class=cp>{%</span> <span class=k>if</span> <span class=nv>image_src</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-3 name=__codelineno-79-3 href=#__codelineno-79-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=nv>default</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-4 name=__codelineno-79-4 href=#__codelineno-79-4></a> <span class=p><</span><span class=nt>img</span> <span class=na>src</span><span class=o>=</span><span class=s>"</span><span class=cp>{{</span> <span class=nv>image_src</span> <span class=cp>}}</span><span class=s>"</span> <span class=p>/></span>
|
||
<a id=__codelineno-79-5 name=__codelineno-79-5 href=#__codelineno-79-5></a> <span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-6 name=__codelineno-79-6 href=#__codelineno-79-6></a> <span class=cp>{%</span> <span class=k>elif</span> <span class=nv>name_initials</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-7 name=__codelineno-79-7 href=#__codelineno-79-7></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=nv>default</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-8 name=__codelineno-79-8 href=#__codelineno-79-8></a> <span class=p><</span><span class=nt>div</span> <span class=na>style</span><span class=o>=</span><span class=s>"</span>
|
||
<a id=__codelineno-79-9 name=__codelineno-79-9 href=#__codelineno-79-9></a><span class=s> border-radius: 25px;</span>
|
||
<a id=__codelineno-79-10 name=__codelineno-79-10 href=#__codelineno-79-10></a><span class=s> width: 50px;</span>
|
||
<a id=__codelineno-79-11 name=__codelineno-79-11 href=#__codelineno-79-11></a><span class=s> height: 50px;</span>
|
||
<a id=__codelineno-79-12 name=__codelineno-79-12 href=#__codelineno-79-12></a><span class=s> background: blue;</span>
|
||
<a id=__codelineno-79-13 name=__codelineno-79-13 href=#__codelineno-79-13></a><span class=s> "</span><span class=p>></span>
|
||
<a id=__codelineno-79-14 name=__codelineno-79-14 href=#__codelineno-79-14></a> <span class=cp>{{</span> <span class=nv>name_initials</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-79-15 name=__codelineno-79-15 href=#__codelineno-79-15></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-79-16 name=__codelineno-79-16 href=#__codelineno-79-16></a> <span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-17 name=__codelineno-79-17 href=#__codelineno-79-17></a> <span class=cp>{%</span> <span class=k>else</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-18 name=__codelineno-79-18 href=#__codelineno-79-18></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"image"</span> <span class=nv>default</span> <span class=nv>required</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-19 name=__codelineno-79-19 href=#__codelineno-79-19></a> <span class=cp>{%</span> <span class=k>endif</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-79-20 name=__codelineno-79-20 href=#__codelineno-79-20></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h3 id=accessing-original-content-of-slots>Accessing original content of slots<a class=headerlink href=#accessing-original-content-of-slots title="Permanent link">¤</a></h3> <p><em>Added in version 0.26</em></p> <blockquote> <p>NOTE: In version 0.77, the syntax was changed from</p> <div class=highlight><pre><span></span><code><a id=__codelineno-80-1 name=__codelineno-80-1 href=#__codelineno-80-1></a><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"my_slot"</span> <span class=k>as</span> <span class=s2>"alias"</span> <span class=cp>%}</span><span class=x> </span><span class=cp>{{</span> <span class=nv>alias.default</span> <span class=cp>}}</span>
|
||
</code></pre></div> <p>to</p> <div class=highlight><pre><span></span><code><a id=__codelineno-81-1 name=__codelineno-81-1 href=#__codelineno-81-1></a><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"my_slot"</span> <span class=nv>default</span><span class=o>=</span><span class=s2>"slot_default"</span> <span class=cp>%}</span><span class=x> </span><span class=cp>{{</span> <span class=nv>slot_default</span> <span class=cp>}}</span>
|
||
</code></pre></div> </blockquote> <p>Sometimes you may want to keep the original slot, but only wrap or prepend/append content to it. To do so, you can access the default slot via the <code>default</code> kwarg.</p> <p>Similarly to the <code>data</code> attribute, you specify the variable name through which the default slot will be made available.</p> <p>For instance, let's say you're filling a slot called 'body'. To render the original slot, assign it to a variable using the <code>'default'</code> keyword. You then render this variable to insert the default content:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-82-1 name=__codelineno-82-1 href=#__codelineno-82-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-82-2 name=__codelineno-82-2 href=#__codelineno-82-2></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"body"</span> <span class=nv>default</span><span class=o>=</span><span class=s2>"body_default"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-82-3 name=__codelineno-82-3 href=#__codelineno-82-3></a> <span class=cp>{{</span> <span class=nv>body_default</span> <span class=cp>}}</span>. Have a great day!
|
||
<a id=__codelineno-82-4 name=__codelineno-82-4 href=#__codelineno-82-4></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-82-5 name=__codelineno-82-5 href=#__codelineno-82-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>This produces:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-83-1 name=__codelineno-83-1 href=#__codelineno-83-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"calendar-component"</span><span class=p>></span>
|
||
<a id=__codelineno-83-2 name=__codelineno-83-2 href=#__codelineno-83-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"header"</span><span class=p>></span>
|
||
<a id=__codelineno-83-3 name=__codelineno-83-3 href=#__codelineno-83-3></a> Calendar header
|
||
<a id=__codelineno-83-4 name=__codelineno-83-4 href=#__codelineno-83-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-83-5 name=__codelineno-83-5 href=#__codelineno-83-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"body"</span><span class=p>></span>
|
||
<a id=__codelineno-83-6 name=__codelineno-83-6 href=#__codelineno-83-6></a> Today's date is <span class=p><</span><span class=nt>span</span><span class=p>></span>2020-06-06<span class=p></</span><span class=nt>span</span><span class=p>></span>. Have a great day!
|
||
<a id=__codelineno-83-7 name=__codelineno-83-7 href=#__codelineno-83-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-83-8 name=__codelineno-83-8 href=#__codelineno-83-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>To access the original content of a default slot, set the name to <code>default</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-84-1 name=__codelineno-84-1 href=#__codelineno-84-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2020-06-06"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-84-2 name=__codelineno-84-2 href=#__codelineno-84-2></a> <span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"default"</span> <span class=nv>default</span><span class=o>=</span><span class=s2>"slot_default"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-84-3 name=__codelineno-84-3 href=#__codelineno-84-3></a> <span class=cp>{{</span> <span class=nv>slot_default</span> <span class=cp>}}</span>. Have a great day!
|
||
<a id=__codelineno-84-4 name=__codelineno-84-4 href=#__codelineno-84-4></a> <span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-84-5 name=__codelineno-84-5 href=#__codelineno-84-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h3 id=conditional-slots>Conditional slots<a class=headerlink href=#conditional-slots title="Permanent link">¤</a></h3> <p><em>Added in version 0.26.</em></p> <blockquote> <p>NOTE: In version 0.70, <code>{% if_filled %}</code> tags were replaced with <code>{{ component_vars.is_filled }}</code> variables. If your slot name contained special characters, see the section <a href=#accessing-is_filled-of-slot-names-with-special-characters>Accessing <code>is_filled</code> of slot names with special characters</a>.</p> </blockquote> <p>In certain circumstances, you may want the behavior of slot filling to depend on whether or not a particular slot is filled.</p> <p>For example, suppose we have the following component template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-85-1 name=__codelineno-85-1 href=#__codelineno-85-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"frontmatter-component"</span><span class=p>></span>
|
||
<a id=__codelineno-85-2 name=__codelineno-85-2 href=#__codelineno-85-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"title"</span><span class=p>></span>
|
||
<a id=__codelineno-85-3 name=__codelineno-85-3 href=#__codelineno-85-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"title"</span> <span class=cp>%}</span>Title<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-85-4 name=__codelineno-85-4 href=#__codelineno-85-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-85-5 name=__codelineno-85-5 href=#__codelineno-85-5></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"subtitle"</span><span class=p>></span>
|
||
<a id=__codelineno-85-6 name=__codelineno-85-6 href=#__codelineno-85-6></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"subtitle"</span> <span class=cp>%}</span><span class=c>{# Optional subtitle #}</span><span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-85-7 name=__codelineno-85-7 href=#__codelineno-85-7></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-85-8 name=__codelineno-85-8 href=#__codelineno-85-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>By default the slot named 'subtitle' is empty. Yet when the component is used without explicit fills, the div containing the slot is still rendered, as shown below:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-86-1 name=__codelineno-86-1 href=#__codelineno-86-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"frontmatter-component"</span><span class=p>></span>
|
||
<a id=__codelineno-86-2 name=__codelineno-86-2 href=#__codelineno-86-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"title"</span><span class=p>></span>Title<span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-86-3 name=__codelineno-86-3 href=#__codelineno-86-3></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"subtitle"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-86-4 name=__codelineno-86-4 href=#__codelineno-86-4></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>This may not be what you want. What if instead the outer 'subtitle' div should only be included when the inner slot is in fact filled?</p> <p>The answer is to use the <code>{{ component_vars.is_filled.<name> }}</code> variable. You can use this together with Django's <code>{% if/elif/else/endif %}</code> tags to define a block whose contents will be rendered only if the component slot with the corresponding 'name' is filled.</p> <p>This is what our example looks like with <code>component_vars.is_filled</code>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-87-1 name=__codelineno-87-1 href=#__codelineno-87-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"frontmatter-component"</span><span class=p>></span>
|
||
<a id=__codelineno-87-2 name=__codelineno-87-2 href=#__codelineno-87-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"title"</span><span class=p>></span>
|
||
<a id=__codelineno-87-3 name=__codelineno-87-3 href=#__codelineno-87-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"title"</span> <span class=cp>%}</span>Title<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-87-4 name=__codelineno-87-4 href=#__codelineno-87-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-87-5 name=__codelineno-87-5 href=#__codelineno-87-5></a> <span class=cp>{%</span> <span class=k>if</span> <span class=nv>component_vars.is_filled.subtitle</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-87-6 name=__codelineno-87-6 href=#__codelineno-87-6></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"subtitle"</span><span class=p>></span>
|
||
<a id=__codelineno-87-7 name=__codelineno-87-7 href=#__codelineno-87-7></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"subtitle"</span> <span class=cp>%}</span><span class=c>{# Optional subtitle #}</span><span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-87-8 name=__codelineno-87-8 href=#__codelineno-87-8></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-87-9 name=__codelineno-87-9 href=#__codelineno-87-9></a> <span class=cp>{%</span> <span class=k>endif</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-87-10 name=__codelineno-87-10 href=#__codelineno-87-10></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Here's our example with more complex branching.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-88-1 name=__codelineno-88-1 href=#__codelineno-88-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"frontmatter-component"</span><span class=p>></span>
|
||
<a id=__codelineno-88-2 name=__codelineno-88-2 href=#__codelineno-88-2></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"title"</span><span class=p>></span>
|
||
<a id=__codelineno-88-3 name=__codelineno-88-3 href=#__codelineno-88-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"title"</span> <span class=cp>%}</span>Title<span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-88-4 name=__codelineno-88-4 href=#__codelineno-88-4></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-88-5 name=__codelineno-88-5 href=#__codelineno-88-5></a> <span class=cp>{%</span> <span class=k>if</span> <span class=nv>component_vars.is_filled.subtitle</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-88-6 name=__codelineno-88-6 href=#__codelineno-88-6></a> <span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"subtitle"</span><span class=p>></span>
|
||
<a id=__codelineno-88-7 name=__codelineno-88-7 href=#__codelineno-88-7></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"subtitle"</span> <span class=cp>%}</span><span class=c>{# Optional subtitle #}</span><span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-88-8 name=__codelineno-88-8 href=#__codelineno-88-8></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-88-9 name=__codelineno-88-9 href=#__codelineno-88-9></a> <span class=cp>{%</span> <span class=k>elif</span> <span class=nv>component_vars.is_filled.title</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-88-10 name=__codelineno-88-10 href=#__codelineno-88-10></a> ...
|
||
<a id=__codelineno-88-11 name=__codelineno-88-11 href=#__codelineno-88-11></a> <span class=cp>{%</span> <span class=k>elif</span> <span class=nv>component_vars.is_filled</span><span class=p>.</span><span class=o><</span><span class=nv>name</span><span class=o>></span> <span class=cp>%}</span>
|
||
<a id=__codelineno-88-12 name=__codelineno-88-12 href=#__codelineno-88-12></a> ...
|
||
<a id=__codelineno-88-13 name=__codelineno-88-13 href=#__codelineno-88-13></a> <span class=cp>{%</span> <span class=k>endif</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-88-14 name=__codelineno-88-14 href=#__codelineno-88-14></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Sometimes you're not interested in whether a slot is filled, but rather that it <em>isn't</em>. To negate the meaning of <code>component_vars.is_filled</code>, simply treat it as boolean and negate it with <code>not</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-89-1 name=__codelineno-89-1 href=#__codelineno-89-1></a><span class=cp>{%</span> <span class=k>if</span> <span class=k>not</span> <span class=nv>component_vars.is_filled.subtitle</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-89-2 name=__codelineno-89-2 href=#__codelineno-89-2></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"subtitle"</span><span class=p>></span>
|
||
<a id=__codelineno-89-3 name=__codelineno-89-3 href=#__codelineno-89-3></a> <span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"subtitle"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-89-4 name=__codelineno-89-4 href=#__codelineno-89-4></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-89-5 name=__codelineno-89-5 href=#__codelineno-89-5></a><span class=cp>{%</span> <span class=k>endif</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h4 id=accessing-is_filled-of-slot-names-with-special-characters>Accessing <code>is_filled</code> of slot names with special characters<a class=headerlink href=#accessing-is_filled-of-slot-names-with-special-characters title="Permanent link">¤</a></h4> <p>To be able to access a slot name via <code>component_vars.is_filled</code>, the slot name needs to be composed of only alphanumeric characters and underscores (e.g. <code>this__isvalid_123</code>).</p> <p>However, you can still define slots with other special characters. In such case, the slot name in <code>component_vars.is_filled</code> is modified to replace all invalid characters into <code>_</code>.</p> <p>So a slot named <code>"my super-slot :)"</code> will be available as <code>component_vars.is_filled.my_super_slot___</code>.</p> <p>Same applies when you are accessing <code>is_filled</code> from within the Python, e.g.:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-90-1 name=__codelineno-90-1 href=#__codelineno-90-1></a><span class=k>class</span> <span class=nc>MyTable</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-90-2 name=__codelineno-90-2 href=#__codelineno-90-2></a> <span class=k>def</span> <span class=nf>on_render_before</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>context</span><span class=p>,</span> <span class=n>template</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||
<a id=__codelineno-90-3 name=__codelineno-90-3 href=#__codelineno-90-3></a> <span class=c1># ✅ Works</span>
|
||
<a id=__codelineno-90-4 name=__codelineno-90-4 href=#__codelineno-90-4></a> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>is_filled</span><span class=p>[</span><span class=s2>"my_super_slot___"</span><span class=p>]:</span>
|
||
<a id=__codelineno-90-5 name=__codelineno-90-5 href=#__codelineno-90-5></a> <span class=c1># Do something</span>
|
||
<a id=__codelineno-90-6 name=__codelineno-90-6 href=#__codelineno-90-6></a>
|
||
<a id=__codelineno-90-7 name=__codelineno-90-7 href=#__codelineno-90-7></a> <span class=c1># ❌ Does not work</span>
|
||
<a id=__codelineno-90-8 name=__codelineno-90-8 href=#__codelineno-90-8></a> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>is_filled</span><span class=p>[</span><span class=s2>"my super-slot :)"</span><span class=p>]:</span>
|
||
<a id=__codelineno-90-9 name=__codelineno-90-9 href=#__codelineno-90-9></a> <span class=c1># Do something</span>
|
||
</code></pre></div> <h3 id=scoped-slots>Scoped slots<a class=headerlink href=#scoped-slots title="Permanent link">¤</a></h3> <p><em>Added in version 0.76</em>:</p> <p>Consider a component with slot(s). This component may do some processing on the inputs, and then use the processed variable in the slot's default template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-91-1 name=__codelineno-91-1 href=#__codelineno-91-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
||
<a id=__codelineno-91-2 name=__codelineno-91-2 href=#__codelineno-91-2></a><span class=k>class</span> <span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-91-3 name=__codelineno-91-3 href=#__codelineno-91-3></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-91-4 name=__codelineno-91-4 href=#__codelineno-91-4></a><span class=s2> <div></span>
|
||
<a id=__codelineno-91-5 name=__codelineno-91-5 href=#__codelineno-91-5></a><span class=s2> {</span><span class=si>% s</span><span class=s2>lot "content" default %}</span>
|
||
<a id=__codelineno-91-6 name=__codelineno-91-6 href=#__codelineno-91-6></a><span class=s2> input: {{ input }}</span>
|
||
<a id=__codelineno-91-7 name=__codelineno-91-7 href=#__codelineno-91-7></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndslot %}</span>
|
||
<a id=__codelineno-91-8 name=__codelineno-91-8 href=#__codelineno-91-8></a><span class=s2> </div></span>
|
||
<a id=__codelineno-91-9 name=__codelineno-91-9 href=#__codelineno-91-9></a><span class=s2> """</span>
|
||
<a id=__codelineno-91-10 name=__codelineno-91-10 href=#__codelineno-91-10></a>
|
||
<a id=__codelineno-91-11 name=__codelineno-91-11 href=#__codelineno-91-11></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=nb>input</span><span class=p>):</span>
|
||
<a id=__codelineno-91-12 name=__codelineno-91-12 href=#__codelineno-91-12></a> <span class=n>processed_input</span> <span class=o>=</span> <span class=n>do_something</span><span class=p>(</span><span class=nb>input</span><span class=p>)</span>
|
||
<a id=__codelineno-91-13 name=__codelineno-91-13 href=#__codelineno-91-13></a> <span class=k>return</span> <span class=p>{</span><span class=s2>"input"</span><span class=p>:</span> <span class=n>processed_input</span><span class=p>}</span>
|
||
</code></pre></div> <p>You may want to design a component so that users of your component can still access the <code>input</code> variable, so they don't have to recompute it.</p> <p>This behavior is called "scoped slots". This is inspired by <a href=https://vuejs.org/guide/components/slots.html#scoped-slots>Vue scoped slots</a> and <a href="https://github.com/Xzya/django-web-components/tree/master?tab=readme-ov-file#scoped-slots">scoped slots of django-web-components</a>.</p> <p>Using scoped slots consists of two steps:</p> <ol> <li>Passing data to <code>slot</code> tag</li> <li>Accessing data in <code>fill</code> tag</li> </ol> <h4 id=passing-data-to-slots>Passing data to slots<a class=headerlink href=#passing-data-to-slots title="Permanent link">¤</a></h4> <p>To pass the data to the <code>slot</code> tag, simply pass them as keyword attributes (<code>key=value</code>):</p> <div class=highlight><pre><span></span><code><a id=__codelineno-92-1 name=__codelineno-92-1 href=#__codelineno-92-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
||
<a id=__codelineno-92-2 name=__codelineno-92-2 href=#__codelineno-92-2></a><span class=k>class</span> <span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-92-3 name=__codelineno-92-3 href=#__codelineno-92-3></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-92-4 name=__codelineno-92-4 href=#__codelineno-92-4></a><span class=s2> <div></span>
|
||
<a id=__codelineno-92-5 name=__codelineno-92-5 href=#__codelineno-92-5></a><span class=s2> {</span><span class=si>% s</span><span class=s2>lot "content" default input=input %}</span>
|
||
<a id=__codelineno-92-6 name=__codelineno-92-6 href=#__codelineno-92-6></a><span class=s2> input: {{ input }}</span>
|
||
<a id=__codelineno-92-7 name=__codelineno-92-7 href=#__codelineno-92-7></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndslot %}</span>
|
||
<a id=__codelineno-92-8 name=__codelineno-92-8 href=#__codelineno-92-8></a><span class=s2> </div></span>
|
||
<a id=__codelineno-92-9 name=__codelineno-92-9 href=#__codelineno-92-9></a><span class=s2> """</span>
|
||
<a id=__codelineno-92-10 name=__codelineno-92-10 href=#__codelineno-92-10></a>
|
||
<a id=__codelineno-92-11 name=__codelineno-92-11 href=#__codelineno-92-11></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=nb>input</span><span class=p>):</span>
|
||
<a id=__codelineno-92-12 name=__codelineno-92-12 href=#__codelineno-92-12></a> <span class=n>processed_input</span> <span class=o>=</span> <span class=n>do_something</span><span class=p>(</span><span class=nb>input</span><span class=p>)</span>
|
||
<a id=__codelineno-92-13 name=__codelineno-92-13 href=#__codelineno-92-13></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-92-14 name=__codelineno-92-14 href=#__codelineno-92-14></a> <span class=s2>"input"</span><span class=p>:</span> <span class=n>processed_input</span><span class=p>,</span>
|
||
<a id=__codelineno-92-15 name=__codelineno-92-15 href=#__codelineno-92-15></a> <span class=p>}</span>
|
||
</code></pre></div> <h4 id=accessing-slot-data-in-fill>Accessing slot data in fill<a class=headerlink href=#accessing-slot-data-in-fill title="Permanent link">¤</a></h4> <p>Next, we head over to where we define a fill for this slot. Here, to access the slot data we set the <code>data</code> attribute to the name of the variable through which we want to access the slot data. In the example below, we set it to <code>data</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-93-1 name=__codelineno-93-1 href=#__codelineno-93-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-93-2 name=__codelineno-93-2 href=#__codelineno-93-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"content"</span> <span class=nv>data</span><span class=o>=</span><span class=s2>"slot_data"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-93-3 name=__codelineno-93-3 href=#__codelineno-93-3></a><span class=x> </span><span class=cp>{{</span> <span class=nv>slot_data.input</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-93-4 name=__codelineno-93-4 href=#__codelineno-93-4></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-93-5 name=__codelineno-93-5 href=#__codelineno-93-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>To access slot data on a default slot, you have to explictly define the <code>{% fill %}</code> tags.</p> <p>So this works:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-94-1 name=__codelineno-94-1 href=#__codelineno-94-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-94-2 name=__codelineno-94-2 href=#__codelineno-94-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"default"</span> <span class=nv>data</span><span class=o>=</span><span class=s2>"slot_data"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-94-3 name=__codelineno-94-3 href=#__codelineno-94-3></a><span class=x> </span><span class=cp>{{</span> <span class=nv>slot_data.input</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-94-4 name=__codelineno-94-4 href=#__codelineno-94-4></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-94-5 name=__codelineno-94-5 href=#__codelineno-94-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>While this does not:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-95-1 name=__codelineno-95-1 href=#__codelineno-95-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span> <span class=nv>data</span><span class=o>=</span><span class=s2>"data"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-95-2 name=__codelineno-95-2 href=#__codelineno-95-2></a><span class=x> </span><span class=cp>{{</span> <span class=nv>data.input</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-95-3 name=__codelineno-95-3 href=#__codelineno-95-3></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Note: You cannot set the <code>data</code> attribute and <a href=#accessing-original-content-of-slots><code>default</code> attribute)</a> to the same name. This raises an error:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-96-1 name=__codelineno-96-1 href=#__codelineno-96-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-96-2 name=__codelineno-96-2 href=#__codelineno-96-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"content"</span> <span class=nv>data</span><span class=o>=</span><span class=s2>"slot_var"</span> <span class=nv>default</span><span class=o>=</span><span class=s2>"slot_var"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-96-3 name=__codelineno-96-3 href=#__codelineno-96-3></a><span class=x> </span><span class=cp>{{</span> <span class=nv>slot_var.input</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-96-4 name=__codelineno-96-4 href=#__codelineno-96-4></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-96-5 name=__codelineno-96-5 href=#__codelineno-96-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h3 id=dynamic-slots-and-fills>Dynamic slots and fills<a class=headerlink href=#dynamic-slots-and-fills title="Permanent link">¤</a></h3> <p>Until now, we were declaring slot and fill names statically, as a string literal, e.g.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-97-1 name=__codelineno-97-1 href=#__codelineno-97-1></a><span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"content"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>However, sometimes you may want to generate slots based on the given input. One example of this is <a href=https://vuetifyjs.com/en/api/v-data-table/ >a table component like that of Vuetify</a>, which creates a header and an item slots for each user-defined column.</p> <p>In django_components you can achieve the same, simply by using a variable (or a <a href=#use-template-tags-inside-component-inputs>template expression</a>) instead of a string literal:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-98-1 name=__codelineno-98-1 href=#__codelineno-98-1></a><span class=x><table></span>
|
||
<a id=__codelineno-98-2 name=__codelineno-98-2 href=#__codelineno-98-2></a><span class=x> <tr></span>
|
||
<a id=__codelineno-98-3 name=__codelineno-98-3 href=#__codelineno-98-3></a><span class=x> </span><span class=cp>{%</span> <span class=k>for</span> <span class=nv>header</span> <span class=k>in</span> <span class=nv>headers</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-98-4 name=__codelineno-98-4 href=#__codelineno-98-4></a><span class=x> <th></span>
|
||
<a id=__codelineno-98-5 name=__codelineno-98-5 href=#__codelineno-98-5></a><span class=x> </span><span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"header-{{ header.key }}"</span> <span class=nv>value</span><span class=o>=</span><span class=nv>header.title</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-98-6 name=__codelineno-98-6 href=#__codelineno-98-6></a><span class=x> </span><span class=cp>{{</span> <span class=nv>header.title</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-98-7 name=__codelineno-98-7 href=#__codelineno-98-7></a><span class=x> </span><span class=cp>{%</span> <span class=k>endslot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-98-8 name=__codelineno-98-8 href=#__codelineno-98-8></a><span class=x> </th></span>
|
||
<a id=__codelineno-98-9 name=__codelineno-98-9 href=#__codelineno-98-9></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfor</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-98-10 name=__codelineno-98-10 href=#__codelineno-98-10></a><span class=x> </tr></span>
|
||
<a id=__codelineno-98-11 name=__codelineno-98-11 href=#__codelineno-98-11></a><span class=x></table></span>
|
||
</code></pre></div> <p>When using the component, you can either set the fill explicitly:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-99-1 name=__codelineno-99-1 href=#__codelineno-99-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"table"</span> <span class=nv>headers</span><span class=o>=</span><span class=nv>headers</span> <span class=nv>items</span><span class=o>=</span><span class=nv>items</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-99-2 name=__codelineno-99-2 href=#__codelineno-99-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"header-name"</span> <span class=nv>data</span><span class=o>=</span><span class=s2>"data"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-99-3 name=__codelineno-99-3 href=#__codelineno-99-3></a><span class=x> <b></span><span class=cp>{{</span> <span class=nv>data.value</span> <span class=cp>}}</span><span class=x></b></span>
|
||
<a id=__codelineno-99-4 name=__codelineno-99-4 href=#__codelineno-99-4></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-99-5 name=__codelineno-99-5 href=#__codelineno-99-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Or also use a variable:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-100-1 name=__codelineno-100-1 href=#__codelineno-100-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"table"</span> <span class=nv>headers</span><span class=o>=</span><span class=nv>headers</span> <span class=nv>items</span><span class=o>=</span><span class=nv>items</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-100-2 name=__codelineno-100-2 href=#__codelineno-100-2></a><span class=x> </span><span class=c>{# Make only the active column bold #}</span>
|
||
<a id=__codelineno-100-3 name=__codelineno-100-3 href=#__codelineno-100-3></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"header-{{ active_header_name }}"</span> <span class=nv>data</span><span class=o>=</span><span class=s2>"data"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-100-4 name=__codelineno-100-4 href=#__codelineno-100-4></a><span class=x> <b></span><span class=cp>{{</span> <span class=nv>data.value</span> <span class=cp>}}</span><span class=x></b></span>
|
||
<a id=__codelineno-100-5 name=__codelineno-100-5 href=#__codelineno-100-5></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-100-6 name=__codelineno-100-6 href=#__codelineno-100-6></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <blockquote> <p>NOTE: It's better to use static slot names whenever possible for clarity. The dynamic slot names should be reserved for advanced use only.</p> </blockquote> <p>Lastly, in rare cases, you can also pass the slot name via <a href=#spread-operator>the spread operator</a>. This is possible, because the slot name argument is actually a shortcut for a <code>name</code> keyword argument.</p> <p>So this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-101-1 name=__codelineno-101-1 href=#__codelineno-101-1></a><span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"content"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>is the same as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-102-1 name=__codelineno-102-1 href=#__codelineno-102-1></a><span class=cp>{%</span> <span class=k>slot</span> <span class=nv>name</span><span class=o>=</span><span class=s2>"content"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>So it's possible to define a <code>name</code> key on a dictionary, and then spread that onto the slot tag:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-103-1 name=__codelineno-103-1 href=#__codelineno-103-1></a><span class=c>{# slot_props = {"name": "content"} #}</span>
|
||
<a id=__codelineno-103-2 name=__codelineno-103-2 href=#__codelineno-103-2></a><span class=cp>{%</span> <span class=k>slot</span> <span class=p>..</span><span class=nv>.slot_props</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h3 id=pass-through-all-the-slots>Pass through all the slots<a class=headerlink href=#pass-through-all-the-slots title="Permanent link">¤</a></h3> <p>You can dynamically pass all slots to a child component. This is similar to <a href=https://vue-land.github.io/faq/forwarding-slots#passing-all-slots>passing all slots in Vue</a>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-104-1 name=__codelineno-104-1 href=#__codelineno-104-1></a><span class=k>class</span> <span class=nc>MyTable</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-104-2 name=__codelineno-104-2 href=#__codelineno-104-2></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-104-3 name=__codelineno-104-3 href=#__codelineno-104-3></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-104-4 name=__codelineno-104-4 href=#__codelineno-104-4></a> <span class=s2>"slots"</span><span class=p>:</span> <span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>slots</span><span class=p>,</span>
|
||
<a id=__codelineno-104-5 name=__codelineno-104-5 href=#__codelineno-104-5></a> <span class=p>}</span>
|
||
<a id=__codelineno-104-6 name=__codelineno-104-6 href=#__codelineno-104-6></a>
|
||
<a id=__codelineno-104-7 name=__codelineno-104-7 href=#__codelineno-104-7></a> <span class=n>template</span><span class=p>:</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-104-8 name=__codelineno-104-8 href=#__codelineno-104-8></a><span class=s2> <div></span>
|
||
<a id=__codelineno-104-9 name=__codelineno-104-9 href=#__codelineno-104-9></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent "child" %}</span>
|
||
<a id=__codelineno-104-10 name=__codelineno-104-10 href=#__codelineno-104-10></a><span class=s2> {</span><span class=si>% f</span><span class=s2>or slot_name in slots %}</span>
|
||
<a id=__codelineno-104-11 name=__codelineno-104-11 href=#__codelineno-104-11></a><span class=s2> {</span><span class=si>% f</span><span class=s2>ill name=slot_name data="data" %}</span>
|
||
<a id=__codelineno-104-12 name=__codelineno-104-12 href=#__codelineno-104-12></a><span class=s2> {</span><span class=si>% s</span><span class=s2>lot name=slot_name ...data / %}</span>
|
||
<a id=__codelineno-104-13 name=__codelineno-104-13 href=#__codelineno-104-13></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndfill %}</span>
|
||
<a id=__codelineno-104-14 name=__codelineno-104-14 href=#__codelineno-104-14></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndfor %}</span>
|
||
<a id=__codelineno-104-15 name=__codelineno-104-15 href=#__codelineno-104-15></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndcomponent %}</span>
|
||
<a id=__codelineno-104-16 name=__codelineno-104-16 href=#__codelineno-104-16></a><span class=s2> </div></span>
|
||
<a id=__codelineno-104-17 name=__codelineno-104-17 href=#__codelineno-104-17></a><span class=s2> """</span>
|
||
</code></pre></div> <h2 id=accessing-data-passed-to-the-component>Accessing data passed to the component<a class=headerlink href=#accessing-data-passed-to-the-component title="Permanent link">¤</a></h2> <p>When you call <code>Component.render</code> or <code>Component.render_to_response</code>, the inputs to these methods can be accessed from within the instance under <code>self.input</code>.</p> <p>This means that you can use <code>self.input</code> inside: - <code>get_context_data</code> - <code>get_template_name</code> - <code>get_template</code> - <code>on_render_before</code> - <code>on_render_after</code></p> <p><code>self.input</code> is only defined during the execution of <code>Component.render</code>, and raises a <code>RuntimeError</code> when called outside of this context.</p> <p><code>self.input</code> has the same fields as the input to <code>Component.render</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-105-1 name=__codelineno-105-1 href=#__codelineno-105-1></a><span class=k>class</span> <span class=nc>TestComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-105-2 name=__codelineno-105-2 href=#__codelineno-105-2></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>var1</span><span class=p>,</span> <span class=n>var2</span><span class=p>,</span> <span class=n>variable</span><span class=p>,</span> <span class=n>another</span><span class=p>,</span> <span class=o>**</span><span class=n>attrs</span><span class=p>):</span>
|
||
<a id=__codelineno-105-3 name=__codelineno-105-3 href=#__codelineno-105-3></a> <span class=k>assert</span> <span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>args</span> <span class=o>==</span> <span class=p>(</span><span class=mi>123</span><span class=p>,</span> <span class=s2>"str"</span><span class=p>)</span>
|
||
<a id=__codelineno-105-4 name=__codelineno-105-4 href=#__codelineno-105-4></a> <span class=k>assert</span> <span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>kwargs</span> <span class=o>==</span> <span class=p>{</span><span class=s2>"variable"</span><span class=p>:</span> <span class=s2>"test"</span><span class=p>,</span> <span class=s2>"another"</span><span class=p>:</span> <span class=mi>1</span><span class=p>}</span>
|
||
<a id=__codelineno-105-5 name=__codelineno-105-5 href=#__codelineno-105-5></a> <span class=k>assert</span> <span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>slots</span> <span class=o>==</span> <span class=p>{</span><span class=s2>"my_slot"</span><span class=p>:</span> <span class=o>...</span><span class=p>}</span>
|
||
<a id=__codelineno-105-6 name=__codelineno-105-6 href=#__codelineno-105-6></a> <span class=k>assert</span> <span class=nb>isinstance</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>context</span><span class=p>,</span> <span class=n>Context</span><span class=p>)</span>
|
||
<a id=__codelineno-105-7 name=__codelineno-105-7 href=#__codelineno-105-7></a>
|
||
<a id=__codelineno-105-8 name=__codelineno-105-8 href=#__codelineno-105-8></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-105-9 name=__codelineno-105-9 href=#__codelineno-105-9></a> <span class=s2>"variable"</span><span class=p>:</span> <span class=n>variable</span><span class=p>,</span>
|
||
<a id=__codelineno-105-10 name=__codelineno-105-10 href=#__codelineno-105-10></a> <span class=p>}</span>
|
||
<a id=__codelineno-105-11 name=__codelineno-105-11 href=#__codelineno-105-11></a>
|
||
<a id=__codelineno-105-12 name=__codelineno-105-12 href=#__codelineno-105-12></a><span class=n>rendered</span> <span class=o>=</span> <span class=n>TestComponent</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-105-13 name=__codelineno-105-13 href=#__codelineno-105-13></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span><span class=s2>"variable"</span><span class=p>:</span> <span class=s2>"test"</span><span class=p>,</span> <span class=s2>"another"</span><span class=p>:</span> <span class=mi>1</span><span class=p>},</span>
|
||
<a id=__codelineno-105-14 name=__codelineno-105-14 href=#__codelineno-105-14></a> <span class=n>args</span><span class=o>=</span><span class=p>(</span><span class=mi>123</span><span class=p>,</span> <span class=s2>"str"</span><span class=p>),</span>
|
||
<a id=__codelineno-105-15 name=__codelineno-105-15 href=#__codelineno-105-15></a> <span class=n>slots</span><span class=o>=</span><span class=p>{</span><span class=s2>"my_slot"</span><span class=p>:</span> <span class=s2>"MY_SLOT"</span><span class=p>},</span>
|
||
<a id=__codelineno-105-16 name=__codelineno-105-16 href=#__codelineno-105-16></a><span class=p>)</span>
|
||
</code></pre></div> <p>NOTE: The slots in <code>self.input.slots</code> are normalized to slot functions.</p> <h2 id=rendering-html-attributes>Rendering HTML attributes<a class=headerlink href=#rendering-html-attributes title="Permanent link">¤</a></h2> <p><em>New in version 0.74</em>:</p> <p>You can use the <code>html_attrs</code> tag to render HTML attributes, given a dictionary of values.</p> <p>So if you have a template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-106-1 name=__codelineno-106-1 href=#__codelineno-106-1></a><span class=x><div class="</span><span class=cp>{{</span> <span class=nv>classes</span> <span class=cp>}}</span><span class=x>" data-id="</span><span class=cp>{{</span> <span class=nv>my_id</span> <span class=cp>}}</span><span class=x>"></span>
|
||
<a id=__codelineno-106-2 name=__codelineno-106-2 href=#__codelineno-106-2></a><span class=x></div></span>
|
||
</code></pre></div> <p>You can simplify it with <code>html_attrs</code> tag:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-107-1 name=__codelineno-107-1 href=#__codelineno-107-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=cp>%}</span><span class=x>></span>
|
||
<a id=__codelineno-107-2 name=__codelineno-107-2 href=#__codelineno-107-2></a><span class=x></div></span>
|
||
</code></pre></div> <p>where <code>attrs</code> is:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-108-1 name=__codelineno-108-1 href=#__codelineno-108-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-108-2 name=__codelineno-108-2 href=#__codelineno-108-2></a> <span class=s2>"class"</span><span class=p>:</span> <span class=n>classes</span><span class=p>,</span>
|
||
<a id=__codelineno-108-3 name=__codelineno-108-3 href=#__codelineno-108-3></a> <span class=s2>"data-id"</span><span class=p>:</span> <span class=n>my_id</span><span class=p>,</span>
|
||
<a id=__codelineno-108-4 name=__codelineno-108-4 href=#__codelineno-108-4></a><span class=p>}</span>
|
||
</code></pre></div> <p>This feature is inspired by <a href="https://github.com/Xzya/django-web-components/tree/master?tab=readme-ov-file#default--merged-attributes"><code>merge_attrs</code> tag of django-web-components</a> and <a href=https://vuejs.org/guide/components/attrs>"fallthrough attributes" feature of Vue</a>.</p> <h3 id=removing-atttributes>Removing atttributes<a class=headerlink href=#removing-atttributes title="Permanent link">¤</a></h3> <p>Attributes that are set to <code>None</code> or <code>False</code> are NOT rendered.</p> <p>So given this input:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-109-1 name=__codelineno-109-1 href=#__codelineno-109-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-109-2 name=__codelineno-109-2 href=#__codelineno-109-2></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"text-green"</span><span class=p>,</span>
|
||
<a id=__codelineno-109-3 name=__codelineno-109-3 href=#__codelineno-109-3></a> <span class=s2>"required"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-109-4 name=__codelineno-109-4 href=#__codelineno-109-4></a> <span class=s2>"data-id"</span><span class=p>:</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-109-5 name=__codelineno-109-5 href=#__codelineno-109-5></a><span class=p>}</span>
|
||
</code></pre></div> <p>And template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-110-1 name=__codelineno-110-1 href=#__codelineno-110-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=cp>%}</span><span class=x>></span>
|
||
<a id=__codelineno-110-2 name=__codelineno-110-2 href=#__codelineno-110-2></a><span class=x></div></span>
|
||
</code></pre></div> <p>Then this renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-111-1 name=__codelineno-111-1 href=#__codelineno-111-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"text-green"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h3 id=boolean-attributes>Boolean attributes<a class=headerlink href=#boolean-attributes title="Permanent link">¤</a></h3> <p>In HTML, boolean attributes are usually rendered with no value. Consider the example below where the first button is disabled and the second is not:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-112-1 name=__codelineno-112-1 href=#__codelineno-112-1></a><span class=p><</span><span class=nt>button</span> <span class=na>disabled</span><span class=p>></span>Click me!<span class=p></</span><span class=nt>button</span><span class=p>></span> <span class=p><</span><span class=nt>button</span><span class=p>></span>Click me!<span class=p></</span><span class=nt>button</span><span class=p>></span>
|
||
</code></pre></div> <p>HTML rendering with <code>html_attrs</code> tag or <code>attributes_to_string</code> works the same way, where <code>key=True</code> is rendered simply as <code>key</code>, and <code>key=False</code> is not render at all.</p> <p>So given this input:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-113-1 name=__codelineno-113-1 href=#__codelineno-113-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-113-2 name=__codelineno-113-2 href=#__codelineno-113-2></a> <span class=s2>"disabled"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
||
<a id=__codelineno-113-3 name=__codelineno-113-3 href=#__codelineno-113-3></a> <span class=s2>"autofocus"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-113-4 name=__codelineno-113-4 href=#__codelineno-113-4></a><span class=p>}</span>
|
||
</code></pre></div> <p>And template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-114-1 name=__codelineno-114-1 href=#__codelineno-114-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=cp>%}</span><span class=x>></span>
|
||
<a id=__codelineno-114-2 name=__codelineno-114-2 href=#__codelineno-114-2></a><span class=x></div></span>
|
||
</code></pre></div> <p>Then this renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-115-1 name=__codelineno-115-1 href=#__codelineno-115-1></a><span class=p><</span><span class=nt>div</span> <span class=na>disabled</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h3 id=default-attributes>Default attributes<a class=headerlink href=#default-attributes title="Permanent link">¤</a></h3> <p>Sometimes you may want to specify default values for attributes. You can pass a second argument (or kwarg <code>defaults</code>) to set the defaults.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-116-1 name=__codelineno-116-1 href=#__codelineno-116-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=nv>defaults</span> <span class=cp>%}</span><span class=x>></span>
|
||
<a id=__codelineno-116-2 name=__codelineno-116-2 href=#__codelineno-116-2></a><span class=x> ...</span>
|
||
<a id=__codelineno-116-3 name=__codelineno-116-3 href=#__codelineno-116-3></a><span class=x></div></span>
|
||
</code></pre></div> <p>In the example above, if <code>attrs</code> contains e.g. the <code>class</code> key, <code>html_attrs</code> will render:</p> <p><code>class="{{ attrs.class }}"</code></p> <p>Otherwise, <code>html_attrs</code> will render:</p> <p><code>class="{{ defaults.class }}"</code></p> <h3 id=appending-attributes>Appending attributes<a class=headerlink href=#appending-attributes title="Permanent link">¤</a></h3> <p>For the <code>class</code> HTML attribute, it's common that we want to <em>join</em> multiple values, instead of overriding them. For example, if you're authoring a component, you may want to ensure that the component will ALWAYS have a specific class. Yet, you may want to allow users of your component to supply their own classes.</p> <p>We can achieve this by adding extra kwargs. These values will be appended, instead of overwriting the previous value.</p> <p>So if we have a variable <code>attrs</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-117-1 name=__codelineno-117-1 href=#__codelineno-117-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-117-2 name=__codelineno-117-2 href=#__codelineno-117-2></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"my-class pa-4"</span><span class=p>,</span>
|
||
<a id=__codelineno-117-3 name=__codelineno-117-3 href=#__codelineno-117-3></a><span class=p>}</span>
|
||
</code></pre></div> <p>And on <code>html_attrs</code> tag, we set the key <code>class</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-118-1 name=__codelineno-118-1 href=#__codelineno-118-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"some-class"</span> <span class=cp>%}</span><span class=x>></span>
|
||
<a id=__codelineno-118-2 name=__codelineno-118-2 href=#__codelineno-118-2></a><span class=x></div></span>
|
||
</code></pre></div> <p>Then these will be merged and rendered as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-119-1 name=__codelineno-119-1 href=#__codelineno-119-1></a><span class=p><</span><span class=nt>div</span> <span class=na>data-value</span><span class=o>=</span><span class=s>"my-class pa-4 some-class"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>To simplify merging of variables, you can supply the same key multiple times, and these will be all joined together:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-120-1 name=__codelineno-120-1 href=#__codelineno-120-1></a><span class=c>{# my_var = "class-from-var text-red" #}</span>
|
||
<a id=__codelineno-120-2 name=__codelineno-120-2 href=#__codelineno-120-2></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"some-class another-class"</span> <span class=nv>class</span><span class=o>=</span><span class=nv>my_var</span> <span class=cp>%}</span><span class=x>></span>
|
||
<a id=__codelineno-120-3 name=__codelineno-120-3 href=#__codelineno-120-3></a><span class=x></div></span>
|
||
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-121-1 name=__codelineno-121-1 href=#__codelineno-121-1></a><span class=p><</span><span class=nt>div</span>
|
||
<a id=__codelineno-121-2 name=__codelineno-121-2 href=#__codelineno-121-2></a> <span class=na>data-value</span><span class=o>=</span><span class=s>"my-class pa-4 some-class another-class class-from-var text-red"</span>
|
||
<a id=__codelineno-121-3 name=__codelineno-121-3 href=#__codelineno-121-3></a><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h3 id=rules-for-html_attrs>Rules for <code>html_attrs</code><a class=headerlink href=#rules-for-html_attrs title="Permanent link">¤</a></h3> <ol> <li>Both <code>attrs</code> and <code>defaults</code> can be passed as positional args</li> </ol> <p><code>{% html_attrs attrs defaults key=val %}</code></p> <p>or as kwargs</p> <p><code>{% html_attrs key=val defaults=defaults attrs=attrs %}</code></p> <ol> <li> <p>Both <code>attrs</code> and <code>defaults</code> are optional (can be omitted)</p> </li> <li> <p>Both <code>attrs</code> and <code>defaults</code> are dictionaries, and we can define them the same way <a href=#pass-dictonary-by-its-key-value-pairs>we define dictionaries for the <code>component</code> tag</a>. So either as <code>attrs=attrs</code> or <code>attrs:key=value</code>.</p> </li> <li> <p>All other kwargs are appended and can be repeated.</p> </li> </ol> <h3 id=examples-for-html_attrs>Examples for <code>html_attrs</code><a class=headerlink href=#examples-for-html_attrs title="Permanent link">¤</a></h3> <p>Assuming that:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-122-1 name=__codelineno-122-1 href=#__codelineno-122-1></a><span class=n>class_from_var</span> <span class=o>=</span> <span class=s2>"from-var"</span>
|
||
<a id=__codelineno-122-2 name=__codelineno-122-2 href=#__codelineno-122-2></a>
|
||
<a id=__codelineno-122-3 name=__codelineno-122-3 href=#__codelineno-122-3></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-122-4 name=__codelineno-122-4 href=#__codelineno-122-4></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"from-attrs"</span><span class=p>,</span>
|
||
<a id=__codelineno-122-5 name=__codelineno-122-5 href=#__codelineno-122-5></a> <span class=s2>"type"</span><span class=p>:</span> <span class=s2>"submit"</span><span class=p>,</span>
|
||
<a id=__codelineno-122-6 name=__codelineno-122-6 href=#__codelineno-122-6></a><span class=p>}</span>
|
||
<a id=__codelineno-122-7 name=__codelineno-122-7 href=#__codelineno-122-7></a>
|
||
<a id=__codelineno-122-8 name=__codelineno-122-8 href=#__codelineno-122-8></a><span class=n>defaults</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-122-9 name=__codelineno-122-9 href=#__codelineno-122-9></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"from-defaults"</span><span class=p>,</span>
|
||
<a id=__codelineno-122-10 name=__codelineno-122-10 href=#__codelineno-122-10></a> <span class=s2>"role"</span><span class=p>:</span> <span class=s2>"button"</span><span class=p>,</span>
|
||
<a id=__codelineno-122-11 name=__codelineno-122-11 href=#__codelineno-122-11></a><span class=p>}</span>
|
||
</code></pre></div> <p>Then:</p> <ul> <li>Empty tag <br> <code>{% html_attr %}</code></li> </ul> <p>renders (empty string): <br> <code></code></p> <ul> <li>Only kwargs <br> <code>{% html_attr class="some-class" class=class_from_var data-id="123" %}</code></li> </ul> <p>renders: <br> <code>class="some-class from-var" data-id="123"</code></p> <ul> <li>Only attrs <br> <code>{% html_attr attrs %}</code></li> </ul> <p>renders: <br> <code>class="from-attrs" type="submit"</code></p> <ul> <li>Attrs as kwarg <br> <code>{% html_attr attrs=attrs %}</code></li> </ul> <p>renders: <br> <code>class="from-attrs" type="submit"</code></p> <ul> <li>Only defaults (as kwarg) <br> <code>{% html_attr defaults=defaults %}</code></li> </ul> <p>renders: <br> <code>class="from-defaults" role="button"</code></p> <ul> <li>Attrs using the <code>prefix:key=value</code> construct <br> <code>{% html_attr attrs:class="from-attrs" attrs:type="submit" %}</code></li> </ul> <p>renders: <br> <code>class="from-attrs" type="submit"</code></p> <ul> <li>Defaults using the <code>prefix:key=value</code> construct <br> <code>{% html_attr defaults:class="from-defaults" %}</code></li> </ul> <p>renders: <br> <code>class="from-defaults" role="button"</code></p> <ul> <li>All together (1) - attrs and defaults as positional args: <br> <code>{% html_attrs attrs defaults class="added_class" class=class_from_var data-id=123 %}</code></li> </ul> <p>renders: <br> <code>class="from-attrs added_class from-var" type="submit" role="button" data-id=123</code></p> <ul> <li>All together (2) - attrs and defaults as kwargs args: <br> <code>{% html_attrs class="added_class" class=class_from_var data-id=123 attrs=attrs defaults=defaults %}</code></li> </ul> <p>renders: <br> <code>class="from-attrs added_class from-var" type="submit" role="button" data-id=123</code></p> <ul> <li>All together (3) - mixed: <br> <code>{% html_attrs attrs defaults:class="default-class" class="added_class" class=class_from_var data-id=123 %}</code></li> </ul> <p>renders: <br> <code>class="from-attrs added_class from-var" type="submit" data-id=123</code></p> <h3 id=full-example-for-html_attrs>Full example for <code>html_attrs</code><a class=headerlink href=#full-example-for-html_attrs title="Permanent link">¤</a></h3> <div class=highlight><pre><span></span><code><a id=__codelineno-123-1 name=__codelineno-123-1 href=#__codelineno-123-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
||
<a id=__codelineno-123-2 name=__codelineno-123-2 href=#__codelineno-123-2></a><span class=k>class</span> <span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-123-3 name=__codelineno-123-3 href=#__codelineno-123-3></a> <span class=n>template</span><span class=p>:</span> <span class=n>t</span><span class=o>.</span><span class=n>django_html</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-123-4 name=__codelineno-123-4 href=#__codelineno-123-4></a><span class=s2> <div</span>
|
||
<a id=__codelineno-123-5 name=__codelineno-123-5 href=#__codelineno-123-5></a><span class=s2> {% html_attrs attrs</span>
|
||
<a id=__codelineno-123-6 name=__codelineno-123-6 href=#__codelineno-123-6></a><span class=s2> defaults:class="pa-4 text-red"</span>
|
||
<a id=__codelineno-123-7 name=__codelineno-123-7 href=#__codelineno-123-7></a><span class=s2> class="my-comp-date"</span>
|
||
<a id=__codelineno-123-8 name=__codelineno-123-8 href=#__codelineno-123-8></a><span class=s2> class=class_from_var</span>
|
||
<a id=__codelineno-123-9 name=__codelineno-123-9 href=#__codelineno-123-9></a><span class=s2> data-id="123"</span>
|
||
<a id=__codelineno-123-10 name=__codelineno-123-10 href=#__codelineno-123-10></a><span class=s2> %}</span>
|
||
<a id=__codelineno-123-11 name=__codelineno-123-11 href=#__codelineno-123-11></a><span class=s2> ></span>
|
||
<a id=__codelineno-123-12 name=__codelineno-123-12 href=#__codelineno-123-12></a><span class=s2> Today's date is <span>{{ date }}</span></span>
|
||
<a id=__codelineno-123-13 name=__codelineno-123-13 href=#__codelineno-123-13></a><span class=s2> </div></span>
|
||
<a id=__codelineno-123-14 name=__codelineno-123-14 href=#__codelineno-123-14></a><span class=s2> """</span>
|
||
<a id=__codelineno-123-15 name=__codelineno-123-15 href=#__codelineno-123-15></a>
|
||
<a id=__codelineno-123-16 name=__codelineno-123-16 href=#__codelineno-123-16></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>:</span> <span class=n>Date</span><span class=p>,</span> <span class=n>attrs</span><span class=p>:</span> <span class=nb>dict</span><span class=p>):</span>
|
||
<a id=__codelineno-123-17 name=__codelineno-123-17 href=#__codelineno-123-17></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-123-18 name=__codelineno-123-18 href=#__codelineno-123-18></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
||
<a id=__codelineno-123-19 name=__codelineno-123-19 href=#__codelineno-123-19></a> <span class=s2>"attrs"</span><span class=p>:</span> <span class=n>attrs</span><span class=p>,</span>
|
||
<a id=__codelineno-123-20 name=__codelineno-123-20 href=#__codelineno-123-20></a> <span class=s2>"class_from_var"</span><span class=p>:</span> <span class=s2>"extra-class"</span>
|
||
<a id=__codelineno-123-21 name=__codelineno-123-21 href=#__codelineno-123-21></a> <span class=p>}</span>
|
||
<a id=__codelineno-123-22 name=__codelineno-123-22 href=#__codelineno-123-22></a>
|
||
<a id=__codelineno-123-23 name=__codelineno-123-23 href=#__codelineno-123-23></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"parent"</span><span class=p>)</span>
|
||
<a id=__codelineno-123-24 name=__codelineno-123-24 href=#__codelineno-123-24></a><span class=k>class</span> <span class=nc>Parent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-123-25 name=__codelineno-123-25 href=#__codelineno-123-25></a> <span class=n>template</span><span class=p>:</span> <span class=n>t</span><span class=o>.</span><span class=n>django_html</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-123-26 name=__codelineno-123-26 href=#__codelineno-123-26></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent "my_comp"</span>
|
||
<a id=__codelineno-123-27 name=__codelineno-123-27 href=#__codelineno-123-27></a><span class=s2> date=date</span>
|
||
<a id=__codelineno-123-28 name=__codelineno-123-28 href=#__codelineno-123-28></a><span class=s2> attrs:class="pa-0 border-solid border-red"</span>
|
||
<a id=__codelineno-123-29 name=__codelineno-123-29 href=#__codelineno-123-29></a><span class=s2> attrs:data-json=json_data</span>
|
||
<a id=__codelineno-123-30 name=__codelineno-123-30 href=#__codelineno-123-30></a><span class=s2> attrs:@click="(e) => onClick(e, 'from_parent')"</span>
|
||
<a id=__codelineno-123-31 name=__codelineno-123-31 href=#__codelineno-123-31></a><span class=s2> / %}</span>
|
||
<a id=__codelineno-123-32 name=__codelineno-123-32 href=#__codelineno-123-32></a><span class=s2> """</span>
|
||
<a id=__codelineno-123-33 name=__codelineno-123-33 href=#__codelineno-123-33></a>
|
||
<a id=__codelineno-123-34 name=__codelineno-123-34 href=#__codelineno-123-34></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>:</span> <span class=n>Date</span><span class=p>):</span>
|
||
<a id=__codelineno-123-35 name=__codelineno-123-35 href=#__codelineno-123-35></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-123-36 name=__codelineno-123-36 href=#__codelineno-123-36></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>datetime</span><span class=o>.</span><span class=n>now</span><span class=p>(),</span>
|
||
<a id=__codelineno-123-37 name=__codelineno-123-37 href=#__codelineno-123-37></a> <span class=s2>"json_data"</span><span class=p>:</span> <span class=n>json</span><span class=o>.</span><span class=n>dumps</span><span class=p>({</span><span class=s2>"value"</span><span class=p>:</span> <span class=mi>456</span><span class=p>})</span>
|
||
<a id=__codelineno-123-38 name=__codelineno-123-38 href=#__codelineno-123-38></a> <span class=p>}</span>
|
||
</code></pre></div> <p>Note: For readability, we've split the tags across multiple lines.</p> <p>Inside <code>MyComp</code>, we defined a default attribute</p> <p><code>defaults:class="pa-4 text-red"</code></p> <p>So if <code>attrs</code> includes key <code>class</code>, the default above will be ignored.</p> <p><code>MyComp</code> also defines <code>class</code> key twice. It means that whether the <code>class</code> attribute is taken from <code>attrs</code> or <code>defaults</code>, the two <code>class</code> values will be appended to it.</p> <p>So by default, <code>MyComp</code> renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-124-1 name=__codelineno-124-1 href=#__codelineno-124-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"pa-4 text-red my-comp-date extra-class"</span> <span class=na>data-id</span><span class=o>=</span><span class=s>"123"</span><span class=p>></span>...<span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <p>Next, let's consider what will be rendered when we call <code>MyComp</code> from <code>Parent</code> component.</p> <p><code>MyComp</code> accepts a <code>attrs</code> dictionary, that is passed to <code>html_attrs</code>, so the contents of that dictionary are rendered as the HTML attributes.</p> <p>In <code>Parent</code>, we make use of passing dictionary key-value pairs as kwargs to define individual attributes as if they were regular kwargs.</p> <p>So all kwargs that start with <code>attrs:</code> will be collected into an <code>attrs</code> dict.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-125-1 name=__codelineno-125-1 href=#__codelineno-125-1></a><span class=x> attrs:class="pa-0 border-solid border-red"</span>
|
||
<a id=__codelineno-125-2 name=__codelineno-125-2 href=#__codelineno-125-2></a><span class=x> attrs:data-json=json_data</span>
|
||
<a id=__codelineno-125-3 name=__codelineno-125-3 href=#__codelineno-125-3></a><span class=x> attrs:@click="(e) => onClick(e, 'from_parent')"</span>
|
||
</code></pre></div> <p>And <code>get_context_data</code> of <code>MyComp</code> will receive <code>attrs</code> input with following keys:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-126-1 name=__codelineno-126-1 href=#__codelineno-126-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-126-2 name=__codelineno-126-2 href=#__codelineno-126-2></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"pa-0 border-solid"</span><span class=p>,</span>
|
||
<a id=__codelineno-126-3 name=__codelineno-126-3 href=#__codelineno-126-3></a> <span class=s2>"data-json"</span><span class=p>:</span> <span class=s1>'{"value": 456}'</span><span class=p>,</span>
|
||
<a id=__codelineno-126-4 name=__codelineno-126-4 href=#__codelineno-126-4></a> <span class=s2>"@click"</span><span class=p>:</span> <span class=s2>"(e) => onClick(e, 'from_parent')"</span><span class=p>,</span>
|
||
<a id=__codelineno-126-5 name=__codelineno-126-5 href=#__codelineno-126-5></a><span class=p>}</span>
|
||
</code></pre></div> <p><code>attrs["class"]</code> overrides the default value for <code>class</code>, whereas other keys will be merged.</p> <p>So in the end <code>MyComp</code> will render:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-127-1 name=__codelineno-127-1 href=#__codelineno-127-1></a><span class=p><</span><span class=nt>div</span>
|
||
<a id=__codelineno-127-2 name=__codelineno-127-2 href=#__codelineno-127-2></a> <span class=na>class</span><span class=o>=</span><span class=s>"pa-0 border-solid my-comp-date extra-class"</span>
|
||
<a id=__codelineno-127-3 name=__codelineno-127-3 href=#__codelineno-127-3></a> <span class=na>data-id</span><span class=o>=</span><span class=s>"123"</span>
|
||
<a id=__codelineno-127-4 name=__codelineno-127-4 href=#__codelineno-127-4></a> <span class=na>data-json</span><span class=o>=</span><span class=s>'{"value": 456}'</span>
|
||
<a id=__codelineno-127-5 name=__codelineno-127-5 href=#__codelineno-127-5></a> <span class=err>@</span><span class=na>click</span><span class=o>=</span><span class=s>"(e) => onClick(e, 'from_parent')"</span>
|
||
<a id=__codelineno-127-6 name=__codelineno-127-6 href=#__codelineno-127-6></a><span class=p>></span>
|
||
<a id=__codelineno-127-7 name=__codelineno-127-7 href=#__codelineno-127-7></a> ...
|
||
<a id=__codelineno-127-8 name=__codelineno-127-8 href=#__codelineno-127-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h3 id=rendering-html-attributes-outside-of-templates>Rendering HTML attributes outside of templates<a class=headerlink href=#rendering-html-attributes-outside-of-templates title="Permanent link">¤</a></h3> <p>If you need to use serialize HTML attributes outside of Django template and the <code>html_attrs</code> tag, you can use <code>attributes_to_string</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-128-1 name=__codelineno-128-1 href=#__codelineno-128-1></a><span class=kn>from</span> <span class=nn>django_components.attributes</span> <span class=kn>import</span> <span class=n>attributes_to_string</span>
|
||
<a id=__codelineno-128-2 name=__codelineno-128-2 href=#__codelineno-128-2></a>
|
||
<a id=__codelineno-128-3 name=__codelineno-128-3 href=#__codelineno-128-3></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-128-4 name=__codelineno-128-4 href=#__codelineno-128-4></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"my-class text-red pa-4"</span><span class=p>,</span>
|
||
<a id=__codelineno-128-5 name=__codelineno-128-5 href=#__codelineno-128-5></a> <span class=s2>"data-id"</span><span class=p>:</span> <span class=mi>123</span><span class=p>,</span>
|
||
<a id=__codelineno-128-6 name=__codelineno-128-6 href=#__codelineno-128-6></a> <span class=s2>"required"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
||
<a id=__codelineno-128-7 name=__codelineno-128-7 href=#__codelineno-128-7></a> <span class=s2>"disabled"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-128-8 name=__codelineno-128-8 href=#__codelineno-128-8></a> <span class=s2>"ignored-attr"</span><span class=p>:</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-128-9 name=__codelineno-128-9 href=#__codelineno-128-9></a><span class=p>}</span>
|
||
<a id=__codelineno-128-10 name=__codelineno-128-10 href=#__codelineno-128-10></a>
|
||
<a id=__codelineno-128-11 name=__codelineno-128-11 href=#__codelineno-128-11></a><span class=n>attributes_to_string</span><span class=p>(</span><span class=n>attrs</span><span class=p>)</span>
|
||
<a id=__codelineno-128-12 name=__codelineno-128-12 href=#__codelineno-128-12></a><span class=c1># 'class="my-class text-red pa-4" data-id="123" required'</span>
|
||
</code></pre></div> <h2 id=template-tag-syntax>Template tag syntax<a class=headerlink href=#template-tag-syntax title="Permanent link">¤</a></h2> <p>All template tags in django_component, like <code>{% component %}</code> or <code>{% slot %}</code>, and so on, support extra syntax that makes it possible to write components like in Vue or React (JSX).</p> <h3 id=self-closing-tags>Self-closing tags<a class=headerlink href=#self-closing-tags title="Permanent link">¤</a></h3> <p>When you have a tag like <code>{% component %}</code> or <code>{% slot %}</code>, but it has no content, you can simply append a forward slash <code>/</code> at the end, instead of writing out the closing tags like <code>{% endcomponent %}</code> or <code>{% endslot %}</code>:</p> <p>So this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-129-1 name=__codelineno-129-1 href=#__codelineno-129-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=cp>%}{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>becomes</p> <div class=highlight><pre><span></span><code><a id=__codelineno-130-1 name=__codelineno-130-1 href=#__codelineno-130-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h3 id=special-characters>Special characters<a class=headerlink href=#special-characters title="Permanent link">¤</a></h3> <p><em>New in version 0.71</em>:</p> <p>Keyword arguments can contain special characters <code># @ . - _</code>, so keywords like so are still valid:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-131-1 name=__codelineno-131-1 href=#__codelineno-131-1></a><span class=x><body></span>
|
||
<a id=__codelineno-131-2 name=__codelineno-131-2 href=#__codelineno-131-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>my-date</span><span class=o>=</span><span class=s2>"2015-06-19"</span> <span class=p>@</span><span class=nv>click.native</span><span class=o>=</span><span class=nv>do_something</span> <span class=p>#</span><span class=nv>some_id</span><span class=o>=</span><span class=kp>True</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-131-3 name=__codelineno-131-3 href=#__codelineno-131-3></a><span class=x></body></span>
|
||
</code></pre></div> <p>These can then be accessed inside <code>get_context_data</code> so:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-132-1 name=__codelineno-132-1 href=#__codelineno-132-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-132-2 name=__codelineno-132-2 href=#__codelineno-132-2></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-132-3 name=__codelineno-132-3 href=#__codelineno-132-3></a> <span class=c1># Since # . @ - are not valid identifiers, we have to</span>
|
||
<a id=__codelineno-132-4 name=__codelineno-132-4 href=#__codelineno-132-4></a> <span class=c1># use `**kwargs` so the method can accept these args.</span>
|
||
<a id=__codelineno-132-5 name=__codelineno-132-5 href=#__codelineno-132-5></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-132-6 name=__codelineno-132-6 href=#__codelineno-132-6></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-132-7 name=__codelineno-132-7 href=#__codelineno-132-7></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>kwargs</span><span class=p>[</span><span class=s2>"my-date"</span><span class=p>],</span>
|
||
<a id=__codelineno-132-8 name=__codelineno-132-8 href=#__codelineno-132-8></a> <span class=s2>"id"</span><span class=p>:</span> <span class=n>kwargs</span><span class=p>[</span><span class=s2>"#some_id"</span><span class=p>],</span>
|
||
<a id=__codelineno-132-9 name=__codelineno-132-9 href=#__codelineno-132-9></a> <span class=s2>"on_click"</span><span class=p>:</span> <span class=n>kwargs</span><span class=p>[</span><span class=s2>"@click.native"</span><span class=p>]</span>
|
||
<a id=__codelineno-132-10 name=__codelineno-132-10 href=#__codelineno-132-10></a> <span class=p>}</span>
|
||
</code></pre></div> <h3 id=spread-operator>Spread operator<a class=headerlink href=#spread-operator title="Permanent link">¤</a></h3> <p><em>New in version 0.93</em>:</p> <p>Instead of passing keyword arguments one-by-one:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-133-1 name=__codelineno-133-1 href=#__codelineno-133-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>title</span><span class=o>=</span><span class=s2>"How to abc"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2015-06-19"</span> <span class=nv>author</span><span class=o>=</span><span class=s2>"John Wick"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>You can use a spread operator <code>...dict</code> to apply key-value pairs from a dictionary:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-134-1 name=__codelineno-134-1 href=#__codelineno-134-1></a><span class=n>post_data</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-134-2 name=__codelineno-134-2 href=#__codelineno-134-2></a> <span class=s2>"title"</span><span class=p>:</span> <span class=s2>"How to..."</span><span class=p>,</span>
|
||
<a id=__codelineno-134-3 name=__codelineno-134-3 href=#__codelineno-134-3></a> <span class=s2>"date"</span><span class=p>:</span> <span class=s2>"2015-06-19"</span><span class=p>,</span>
|
||
<a id=__codelineno-134-4 name=__codelineno-134-4 href=#__codelineno-134-4></a> <span class=s2>"author"</span><span class=p>:</span> <span class=s2>"John Wick"</span><span class=p>,</span>
|
||
<a id=__codelineno-134-5 name=__codelineno-134-5 href=#__codelineno-134-5></a><span class=p>}</span>
|
||
</code></pre></div> <div class=highlight><pre><span></span><code><a id=__codelineno-135-1 name=__codelineno-135-1 href=#__codelineno-135-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=p>..</span><span class=nv>.post_data</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>This behaves similar to <a href=https://kevinyckim33.medium.com/jsx-spread-operator-component-props-meaning-3c9bcadd2493>JSX's spread operator</a> or <a href=https://vuejs.org/api/built-in-directives.html#v-bind>Vue's <code>v-bind</code></a>.</p> <p>Spread operators are treated as keyword arguments, which means that: 1. Spread operators must come after positional arguments. 2. You cannot use spread operators for <a href=https://martinxpn.medium.com/positional-only-and-keyword-only-arguments-in-python-37-100-days-of-python-310c311657b0>positional-only arguments</a>.</p> <p>Other than that, you can use spread operators multiple times, and even put keyword arguments in-between or after them:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-136-1 name=__codelineno-136-1 href=#__codelineno-136-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=p>..</span><span class=nv>.post_data</span> <span class=nv>id</span><span class=o>=</span><span class=nv>post.id</span> <span class=p>..</span><span class=nv>.extra</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>In a case of conflicts, the values added later (right-most) overwrite previous values.</p> <h3 id=use-template-tags-inside-component-inputs>Use template tags inside component inputs<a class=headerlink href=#use-template-tags-inside-component-inputs title="Permanent link">¤</a></h3> <p><em>New in version 0.93</em></p> <p>When passing data around, sometimes you may need to do light transformations, like negating booleans or filtering lists.</p> <p>Normally, what you would have to do is to define ALL the variables inside <code>get_context_data()</code>. But this can get messy if your components contain a lot of logic.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-137-1 name=__codelineno-137-1 href=#__codelineno-137-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-137-2 name=__codelineno-137-2 href=#__codelineno-137-2></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-137-3 name=__codelineno-137-3 href=#__codelineno-137-3></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=nb>id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>editable</span><span class=p>:</span> <span class=nb>bool</span><span class=p>):</span>
|
||
<a id=__codelineno-137-4 name=__codelineno-137-4 href=#__codelineno-137-4></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-137-5 name=__codelineno-137-5 href=#__codelineno-137-5></a> <span class=s2>"editable"</span><span class=p>:</span> <span class=n>editable</span><span class=p>,</span>
|
||
<a id=__codelineno-137-6 name=__codelineno-137-6 href=#__codelineno-137-6></a> <span class=s2>"readonly"</span><span class=p>:</span> <span class=ow>not</span> <span class=n>editable</span><span class=p>,</span>
|
||
<a id=__codelineno-137-7 name=__codelineno-137-7 href=#__codelineno-137-7></a> <span class=s2>"input_id"</span><span class=p>:</span> <span class=sa>f</span><span class=s2>"input-</span><span class=si>{</span><span class=nb>id</span><span class=si>}</span><span class=s2>"</span><span class=p>,</span>
|
||
<a id=__codelineno-137-8 name=__codelineno-137-8 href=#__codelineno-137-8></a> <span class=s2>"icon_id"</span><span class=p>:</span> <span class=sa>f</span><span class=s2>"icon-</span><span class=si>{</span><span class=nb>id</span><span class=si>}</span><span class=s2>"</span><span class=p>,</span>
|
||
<a id=__codelineno-137-9 name=__codelineno-137-9 href=#__codelineno-137-9></a> <span class=o>...</span>
|
||
<a id=__codelineno-137-10 name=__codelineno-137-10 href=#__codelineno-137-10></a> <span class=p>}</span>
|
||
</code></pre></div> <p>Instead, template tags in django_components (<code>{% component %}</code>, <code>{% slot %}</code>, <code>{% provide %}</code>, etc) allow you to treat literal string values as templates:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-138-1 name=__codelineno-138-1 href=#__codelineno-138-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s1>'blog_post'</span>
|
||
<a id=__codelineno-138-2 name=__codelineno-138-2 href=#__codelineno-138-2></a> <span class=s2>"As positional arg {# yay #}"</span>
|
||
<a id=__codelineno-138-3 name=__codelineno-138-3 href=#__codelineno-138-3></a> <span class=nv>title</span><span class=o>=</span><span class=s2>"{{ person.first_name }} {{ person.last_name }}"</span>
|
||
<a id=__codelineno-138-4 name=__codelineno-138-4 href=#__codelineno-138-4></a> <span class=nv>id</span><span class=o>=</span><span class=s2>"{% random_int 10 20 %}"</span>
|
||
<a id=__codelineno-138-5 name=__codelineno-138-5 href=#__codelineno-138-5></a> <span class=nv>readonly</span><span class=o>=</span><span class=s2>"{{ editable|not }}"</span>
|
||
<a id=__codelineno-138-6 name=__codelineno-138-6 href=#__codelineno-138-6></a> <span class=nv>author</span><span class=o>=</span><span class=s2>"John Wick {# TODO: parametrize #}"</span>
|
||
<a id=__codelineno-138-7 name=__codelineno-138-7 href=#__codelineno-138-7></a><span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>In the example above: - Component <code>test</code> receives a positional argument with value <code>"As positional arg "</code>. The comment is omitted. - Kwarg <code>title</code> is passed as a string, e.g. <code>John Doe</code> - Kwarg <code>id</code> is passed as <code>int</code>, e.g. <code>15</code> - Kwarg <code>readonly</code> is passed as <code>bool</code>, e.g. <code>False</code> - Kwarg <code>author</code> is passed as a string, e.g. <code>John Wick</code> (Comment omitted)</p> <p>This is inspired by <a href=https://github.com/wrabit/django-cotton#template-expressions-in-attributes>django-cotton</a>.</p> <h4 id=passing-data-as-string-vs-original-values>Passing data as string vs original values<a class=headerlink href=#passing-data-as-string-vs-original-values title="Permanent link">¤</a></h4> <p>Sometimes you may want to use the template tags to transform or generate the data that is then passed to the component.</p> <p>The data doesn't necessarily have to be strings. In the example above, the kwarg <code>id</code> was passed as an integer, NOT a string.</p> <p>Although the string literals for components inputs are treated as regular Django templates, there is one special case:</p> <p>When the string literal contains only a single template tag, with no extra text, then the value is passed as the original type instead of a string.</p> <p>Here, <code>page</code> is an integer:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-139-1 name=__codelineno-139-1 href=#__codelineno-139-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s1>'blog_post'</span> <span class=nv>page</span><span class=o>=</span><span class=s2>"{% random_int 10 20 %}"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Here, <code>page</code> is a string:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-140-1 name=__codelineno-140-1 href=#__codelineno-140-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s1>'blog_post'</span> <span class=nv>page</span><span class=o>=</span><span class=s2>" {% random_int 10 20 %} "</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>And same applies to the <code>{{ }}</code> variable tags:</p> <p>Here, <code>items</code> is a list:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-141-1 name=__codelineno-141-1 href=#__codelineno-141-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s1>'cat_list'</span> <span class=nv>items</span><span class=o>=</span><span class=s2>"{{ cats|slice:':2' }}"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Here, <code>items</code> is a string:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-142-1 name=__codelineno-142-1 href=#__codelineno-142-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s1>'cat_list'</span> <span class=nv>items</span><span class=o>=</span><span class=s2>"{{ cats|slice:':2' }} See more"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h4 id=evaluating-python-expressions-in-template>Evaluating Python expressions in template<a class=headerlink href=#evaluating-python-expressions-in-template title="Permanent link">¤</a></h4> <p>You can even go a step further and have a similar experience to Vue or React, where you can evaluate arbitrary code expressions:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-143-1 name=__codelineno-143-1 href=#__codelineno-143-1></a><span class=p><</span><span class=nt>MyForm</span>
|
||
<a id=__codelineno-143-2 name=__codelineno-143-2 href=#__codelineno-143-2></a><span class=w> </span><span class=na>value</span><span class=o>=</span><span class=p>{</span><span class=w> </span><span class=nx>isEnabled</span><span class=w> </span><span class=o>?</span><span class=w> </span><span class=nx>inputValue</span><span class=w> </span><span class=o>:</span><span class=w> </span><span class=kc>null</span><span class=w> </span><span class=p>}</span>
|
||
<a id=__codelineno-143-3 name=__codelineno-143-3 href=#__codelineno-143-3></a><span class=p>/></span>
|
||
</code></pre></div> <p>Similar is possible with <a href=https://pypi.org/project/django-expr/ ><code>django-expr</code></a>, which adds an <code>expr</code> tag and filter that you can use to evaluate Python expressions from within the template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-144-1 name=__codelineno-144-1 href=#__codelineno-144-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_form"</span>
|
||
<a id=__codelineno-144-2 name=__codelineno-144-2 href=#__codelineno-144-2></a> <span class=nv>value</span><span class=o>=</span><span class=s2>"{% expr 'input_value if is_enabled else None' %}"</span>
|
||
<a id=__codelineno-144-3 name=__codelineno-144-3 href=#__codelineno-144-3></a><span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <blockquote> <p>Note: Never use this feature to mix business logic and template logic. Business logic should still be in the view!</p> </blockquote> <h3 id=pass-dictonary-by-its-key-value-pairs>Pass dictonary by its key-value pairs<a class=headerlink href=#pass-dictonary-by-its-key-value-pairs title="Permanent link">¤</a></h3> <p><em>New in version 0.74</em>:</p> <p>Sometimes, a component may expect a dictionary as one of its inputs.</p> <p>Most commonly, this happens when a component accepts a dictionary of HTML attributes (usually called <code>attrs</code>) to pass to the underlying template.</p> <p>In such cases, we may want to define some HTML attributes statically, and other dynamically. But for that, we need to define this dictionary on Python side:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-145-1 name=__codelineno-145-1 href=#__codelineno-145-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
||
<a id=__codelineno-145-2 name=__codelineno-145-2 href=#__codelineno-145-2></a><span class=k>class</span> <span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-145-3 name=__codelineno-145-3 href=#__codelineno-145-3></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-145-4 name=__codelineno-145-4 href=#__codelineno-145-4></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent "other" attrs=attrs / %}</span>
|
||
<a id=__codelineno-145-5 name=__codelineno-145-5 href=#__codelineno-145-5></a><span class=s2> """</span>
|
||
<a id=__codelineno-145-6 name=__codelineno-145-6 href=#__codelineno-145-6></a>
|
||
<a id=__codelineno-145-7 name=__codelineno-145-7 href=#__codelineno-145-7></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>some_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>):</span>
|
||
<a id=__codelineno-145-8 name=__codelineno-145-8 href=#__codelineno-145-8></a> <span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-145-9 name=__codelineno-145-9 href=#__codelineno-145-9></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"pa-4 flex"</span><span class=p>,</span>
|
||
<a id=__codelineno-145-10 name=__codelineno-145-10 href=#__codelineno-145-10></a> <span class=s2>"data-some-id"</span><span class=p>:</span> <span class=n>some_id</span><span class=p>,</span>
|
||
<a id=__codelineno-145-11 name=__codelineno-145-11 href=#__codelineno-145-11></a> <span class=s2>"@click.stop"</span><span class=p>:</span> <span class=s2>"onClickHandler"</span><span class=p>,</span>
|
||
<a id=__codelineno-145-12 name=__codelineno-145-12 href=#__codelineno-145-12></a> <span class=p>}</span>
|
||
<a id=__codelineno-145-13 name=__codelineno-145-13 href=#__codelineno-145-13></a> <span class=k>return</span> <span class=p>{</span><span class=s2>"attrs"</span><span class=p>:</span> <span class=n>attrs</span><span class=p>}</span>
|
||
</code></pre></div> <p>But as you can see in the case above, the event handler <code>@click.stop</code> and styling <code>pa-4 flex</code> are disconnected from the template. If the component grew in size and we moved the HTML to a separate file, we would have hard time reasoning about the component's template.</p> <p>Luckily, there's a better way.</p> <p>When we want to pass a dictionary to a component, we can define individual key-value pairs as component kwargs, so we can keep all the relevant information in the template. For that, we prefix the key with the name of the dict and <code>:</code>. So key <code>class</code> of input <code>attrs</code> becomes <code>attrs:class</code>. And our example becomes:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-146-1 name=__codelineno-146-1 href=#__codelineno-146-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
||
<a id=__codelineno-146-2 name=__codelineno-146-2 href=#__codelineno-146-2></a><span class=k>class</span> <span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-146-3 name=__codelineno-146-3 href=#__codelineno-146-3></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-146-4 name=__codelineno-146-4 href=#__codelineno-146-4></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent "other"</span>
|
||
<a id=__codelineno-146-5 name=__codelineno-146-5 href=#__codelineno-146-5></a><span class=s2> attrs:class="pa-4 flex"</span>
|
||
<a id=__codelineno-146-6 name=__codelineno-146-6 href=#__codelineno-146-6></a><span class=s2> attrs:data-some-id=some_id</span>
|
||
<a id=__codelineno-146-7 name=__codelineno-146-7 href=#__codelineno-146-7></a><span class=s2> attrs:@click.stop="onClickHandler"</span>
|
||
<a id=__codelineno-146-8 name=__codelineno-146-8 href=#__codelineno-146-8></a><span class=s2> / %}</span>
|
||
<a id=__codelineno-146-9 name=__codelineno-146-9 href=#__codelineno-146-9></a><span class=s2> """</span>
|
||
<a id=__codelineno-146-10 name=__codelineno-146-10 href=#__codelineno-146-10></a>
|
||
<a id=__codelineno-146-11 name=__codelineno-146-11 href=#__codelineno-146-11></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>some_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>):</span>
|
||
<a id=__codelineno-146-12 name=__codelineno-146-12 href=#__codelineno-146-12></a> <span class=k>return</span> <span class=p>{</span><span class=s2>"some_id"</span><span class=p>:</span> <span class=n>some_id</span><span class=p>}</span>
|
||
</code></pre></div> <p>Sweet! Now all the relevant HTML is inside the template, and we can move it to a separate file with confidence:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-147-1 name=__codelineno-147-1 href=#__codelineno-147-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"other"</span>
|
||
<a id=__codelineno-147-2 name=__codelineno-147-2 href=#__codelineno-147-2></a> <span class=nv>attrs</span><span class=o>:</span><span class=nv>class</span><span class=o>=</span><span class=s2>"pa-4 flex"</span>
|
||
<a id=__codelineno-147-3 name=__codelineno-147-3 href=#__codelineno-147-3></a> <span class=nv>attrs</span><span class=o>:</span><span class=nv>data-some-id</span><span class=o>=</span><span class=nv>some_id</span>
|
||
<a id=__codelineno-147-4 name=__codelineno-147-4 href=#__codelineno-147-4></a> <span class=nv>attrs</span><span class=o>:</span><span class=p>@</span><span class=nv>click.stop</span><span class=o>=</span><span class=s2>"onClickHandler"</span>
|
||
<a id=__codelineno-147-5 name=__codelineno-147-5 href=#__codelineno-147-5></a><span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <blockquote> <p>Note: It is NOT possible to define nested dictionaries, so <code>attrs:my_key:two=2</code> would be interpreted as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-148-1 name=__codelineno-148-1 href=#__codelineno-148-1></a><span class=p>{</span><span class=s2>"attrs"</span><span class=p>:</span> <span class=p>{</span><span class=s2>"my_key:two"</span><span class=p>:</span> <span class=mi>2</span><span class=p>}}</span>
|
||
</code></pre></div> </blockquote> <h3 id=multi-line-tags>Multi-line tags<a class=headerlink href=#multi-line-tags title="Permanent link">¤</a></h3> <p>By default, Django expects a template tag to be defined on a single line.</p> <p>However, this can become unwieldy if you have a component with a lot of inputs:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-149-1 name=__codelineno-149-1 href=#__codelineno-149-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"card"</span> <span class=nv>title</span><span class=o>=</span><span class=s2>"Joanne Arc"</span> <span class=nv>subtitle</span><span class=o>=</span><span class=s2>"Head of Kitty Relations"</span> <span class=nv>date_last_active</span><span class=o>=</span><span class=s2>"2024-09-03"</span> <span class=p>...</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Instead, when you install django_components, it automatically configures Django to suport multi-line tags.</p> <p>So we can rewrite the above as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-150-1 name=__codelineno-150-1 href=#__codelineno-150-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"card"</span>
|
||
<a id=__codelineno-150-2 name=__codelineno-150-2 href=#__codelineno-150-2></a> <span class=nv>title</span><span class=o>=</span><span class=s2>"Joanne Arc"</span>
|
||
<a id=__codelineno-150-3 name=__codelineno-150-3 href=#__codelineno-150-3></a> <span class=nv>subtitle</span><span class=o>=</span><span class=s2>"Head of Kitty Relations"</span>
|
||
<a id=__codelineno-150-4 name=__codelineno-150-4 href=#__codelineno-150-4></a> <span class=nv>date_last_active</span><span class=o>=</span><span class=s2>"2024-09-03"</span>
|
||
<a id=__codelineno-150-5 name=__codelineno-150-5 href=#__codelineno-150-5></a> <span class=p>...</span>
|
||
<a id=__codelineno-150-6 name=__codelineno-150-6 href=#__codelineno-150-6></a><span class=cp>%}</span>
|
||
</code></pre></div> <p>Much better!</p> <p>To disable this behavior, set <a href=#multiline_tags---enabledisable-multiline-support><code>COMPONENTS.multiline_tag</code></a> to <code>False</code></p> <h2 id=prop-drilling-and-dependency-injection-provide-inject>Prop drilling and dependency injection (provide / inject)<a class=headerlink href=#prop-drilling-and-dependency-injection-provide-inject title="Permanent link">¤</a></h2> <p><em>New in version 0.80</em>:</p> <p>Django components supports dependency injection with the combination of:</p> <ol> <li><code>{% provide %}</code> tag</li> <li><code>inject()</code> method of the <code>Component</code> class</li> </ol> <h3 id=what-is-dependency-injection-and-prop-drilling>What is "dependency injection" and "prop drilling"?<a class=headerlink href=#what-is-dependency-injection-and-prop-drilling title="Permanent link">¤</a></h3> <p>Prop drilling refers to a scenario in UI development where you need to pass data through many layers of a component tree to reach the nested components that actually need the data.</p> <p>Normally, you'd use props to send data from a parent component to its children. However, this straightforward method becomes cumbersome and inefficient if the data has to travel through many levels or if several components scattered at different depths all need the same piece of information.</p> <p>This results in a situation where the intermediate components, which don't need the data for their own functioning, end up having to manage and pass along these props. This clutters the component tree and makes the code verbose and harder to manage.</p> <p>A neat solution to avoid prop drilling is using the "provide and inject" technique, AKA dependency injection.</p> <p>With dependency injection, a parent component acts like a data hub for all its descendants. This setup allows any component, no matter how deeply nested it is, to access the required data directly from this centralized provider without having to messily pass props down the chain. This approach significantly cleans up the code and makes it easier to maintain.</p> <p>This feature is inspired by Vue's <a href=https://vuejs.org/guide/components/provide-inject>Provide / Inject</a> and React's <a href=https://react.dev/learn/passing-data-deeply-with-context>Context / useContext</a>.</p> <h3 id=how-to-use-provide-inject>How to use provide / inject<a class=headerlink href=#how-to-use-provide-inject title="Permanent link">¤</a></h3> <p>As the name suggest, using provide / inject consists of 2 steps</p> <ol> <li>Providing data</li> <li>Injecting provided data</li> </ol> <p>For examples of advanced uses of provide / inject, <a href=https://github.com/EmilStenstrom/django-components/pull/506#issuecomment-2132102584>see this discussion</a>.</p> <h3 id=using-provide-tag>Using <code>{% provide %}</code> tag<a class=headerlink href=#using-provide-tag title="Permanent link">¤</a></h3> <p>First we use the <code>{% provide %}</code> tag to define the data we want to "provide" (make available).</p> <div class=highlight><pre><span></span><code><a id=__codelineno-151-1 name=__codelineno-151-1 href=#__codelineno-151-1></a><span class=cp>{%</span> <span class=k>provide</span> <span class=s2>"my_data"</span> <span class=nv>key</span><span class=o>=</span><span class=s2>"hi"</span> <span class=nv>another</span><span class=o>=</span><span class=m>123</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-151-2 name=__codelineno-151-2 href=#__codelineno-151-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"child"</span> <span class=o>/</span> <span class=cp>%}</span><span class=x> <--- Can access "my_data"</span>
|
||
<a id=__codelineno-151-3 name=__codelineno-151-3 href=#__codelineno-151-3></a><span class=cp>{%</span> <span class=k>endprovide</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-151-4 name=__codelineno-151-4 href=#__codelineno-151-4></a>
|
||
<a id=__codelineno-151-5 name=__codelineno-151-5 href=#__codelineno-151-5></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"child"</span> <span class=o>/</span> <span class=cp>%}</span><span class=x> <--- Cannot access "my_data"</span>
|
||
</code></pre></div> <p>Notice that the <code>provide</code> tag REQUIRES a name as a first argument. This is the <em>key</em> by which we can then access the data passed to this tag.</p> <p><code>provide</code> tag name must resolve to a valid identifier (AKA a valid Python variable name).</p> <p>Once you've set the name, you define the data you want to "provide" by passing it as keyword arguments. This is similar to how you pass data to the <code>{% with %}</code> tag.</p> <blockquote> <p>NOTE: Kwargs passed to <code>{% provide %}</code> are NOT added to the context. In the example below, the <code>{{ key }}</code> won't render anything:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-152-1 name=__codelineno-152-1 href=#__codelineno-152-1></a><span class=cp>{%</span> <span class=k>provide</span> <span class=s2>"my_data"</span> <span class=nv>key</span><span class=o>=</span><span class=s2>"hi"</span> <span class=nv>another</span><span class=o>=</span><span class=m>123</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-152-2 name=__codelineno-152-2 href=#__codelineno-152-2></a><span class=x> </span><span class=cp>{{</span> <span class=nv>key</span> <span class=cp>}}</span>
|
||
<a id=__codelineno-152-3 name=__codelineno-152-3 href=#__codelineno-152-3></a><span class=cp>{%</span> <span class=k>endprovide</span> <span class=cp>%}</span>
|
||
</code></pre></div> </blockquote> <p>Similarly to <a href=#dynamic-slots-and-fills>slots and fills</a>, also provide's name argument can be set dynamically via a variable, a template expression, or a spread operator:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-153-1 name=__codelineno-153-1 href=#__codelineno-153-1></a><span class=cp>{%</span> <span class=k>provide</span> <span class=nv>name</span><span class=o>=</span><span class=nv>name</span> <span class=p>...</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-153-2 name=__codelineno-153-2 href=#__codelineno-153-2></a><span class=x> ...</span>
|
||
<a id=__codelineno-153-3 name=__codelineno-153-3 href=#__codelineno-153-3></a><span class=cp>{%</span> <span class=k>provide</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-153-4 name=__codelineno-153-4 href=#__codelineno-153-4></a><span class=x></table></span>
|
||
</code></pre></div> <h3 id=using-inject-method>Using <code>inject()</code> method<a class=headerlink href=#using-inject-method title="Permanent link">¤</a></h3> <p>To "inject" (access) the data defined on the <code>provide</code> tag, you can use the <code>inject()</code> method inside of <code>get_context_data()</code>.</p> <p>For a component to be able to "inject" some data, the component (<code>{% component %}</code> tag) must be nested inside the <code>{% provide %}</code> tag.</p> <p>In the example from previous section, we've defined two kwargs: <code>key="hi" another=123</code>. That means that if we now inject <code>"my_data"</code>, we get an object with 2 attributes - <code>key</code> and <code>another</code>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-154-1 name=__codelineno-154-1 href=#__codelineno-154-1></a><span class=k>class</span> <span class=nc>ChildComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-154-2 name=__codelineno-154-2 href=#__codelineno-154-2></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-154-3 name=__codelineno-154-3 href=#__codelineno-154-3></a> <span class=n>my_data</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>inject</span><span class=p>(</span><span class=s2>"my_data"</span><span class=p>)</span>
|
||
<a id=__codelineno-154-4 name=__codelineno-154-4 href=#__codelineno-154-4></a> <span class=nb>print</span><span class=p>(</span><span class=n>my_data</span><span class=o>.</span><span class=n>key</span><span class=p>)</span> <span class=c1># hi</span>
|
||
<a id=__codelineno-154-5 name=__codelineno-154-5 href=#__codelineno-154-5></a> <span class=nb>print</span><span class=p>(</span><span class=n>my_data</span><span class=o>.</span><span class=n>another</span><span class=p>)</span> <span class=c1># 123</span>
|
||
<a id=__codelineno-154-6 name=__codelineno-154-6 href=#__codelineno-154-6></a> <span class=k>return</span> <span class=p>{}</span>
|
||
</code></pre></div> <p>First argument to <code>inject</code> is the <em>key</em> (or <em>name</em>) of the provided data. This must match the string that you used in the <code>provide</code> tag. If no provider with given key is found, <code>inject</code> raises a <code>KeyError</code>.</p> <p>To avoid the error, you can pass a second argument to <code>inject</code> to which will act as a default value, similar to <code>dict.get(key, default)</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-155-1 name=__codelineno-155-1 href=#__codelineno-155-1></a><span class=k>class</span> <span class=nc>ChildComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-155-2 name=__codelineno-155-2 href=#__codelineno-155-2></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-155-3 name=__codelineno-155-3 href=#__codelineno-155-3></a> <span class=n>my_data</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>inject</span><span class=p>(</span><span class=s2>"invalid_key"</span><span class=p>,</span> <span class=n>DEFAULT_DATA</span><span class=p>)</span>
|
||
<a id=__codelineno-155-4 name=__codelineno-155-4 href=#__codelineno-155-4></a> <span class=k>assert</span> <span class=n>my_data</span> <span class=o>==</span> <span class=n>DEFAUKT_DATA</span>
|
||
<a id=__codelineno-155-5 name=__codelineno-155-5 href=#__codelineno-155-5></a> <span class=k>return</span> <span class=p>{}</span>
|
||
</code></pre></div> <p>The instance returned from <code>inject()</code> is a subclass of <code>NamedTuple</code>, so the instance is immutable. This ensures that the data returned from <code>inject</code> will always have all the keys that were passed to the <code>provide</code> tag.</p> <blockquote> <p>NOTE: <code>inject()</code> works strictly only in <code>get_context_data</code>. If you try to call it from elsewhere, it will raise an error.</p> </blockquote> <h3 id=full-example>Full example<a class=headerlink href=#full-example title="Permanent link">¤</a></h3> <div class=highlight><pre><span></span><code><a id=__codelineno-156-1 name=__codelineno-156-1 href=#__codelineno-156-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"child"</span><span class=p>)</span>
|
||
<a id=__codelineno-156-2 name=__codelineno-156-2 href=#__codelineno-156-2></a><span class=k>class</span> <span class=nc>ChildComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-156-3 name=__codelineno-156-3 href=#__codelineno-156-3></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-156-4 name=__codelineno-156-4 href=#__codelineno-156-4></a><span class=s2> <div> {{ my_data.key }} </div></span>
|
||
<a id=__codelineno-156-5 name=__codelineno-156-5 href=#__codelineno-156-5></a><span class=s2> <div> {{ my_data.another }} </div></span>
|
||
<a id=__codelineno-156-6 name=__codelineno-156-6 href=#__codelineno-156-6></a><span class=s2> """</span>
|
||
<a id=__codelineno-156-7 name=__codelineno-156-7 href=#__codelineno-156-7></a>
|
||
<a id=__codelineno-156-8 name=__codelineno-156-8 href=#__codelineno-156-8></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-156-9 name=__codelineno-156-9 href=#__codelineno-156-9></a> <span class=n>my_data</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>inject</span><span class=p>(</span><span class=s2>"my_data"</span><span class=p>,</span> <span class=s2>"default"</span><span class=p>)</span>
|
||
<a id=__codelineno-156-10 name=__codelineno-156-10 href=#__codelineno-156-10></a> <span class=k>return</span> <span class=p>{</span><span class=s2>"my_data"</span><span class=p>:</span> <span class=n>my_data</span><span class=p>}</span>
|
||
<a id=__codelineno-156-11 name=__codelineno-156-11 href=#__codelineno-156-11></a>
|
||
<a id=__codelineno-156-12 name=__codelineno-156-12 href=#__codelineno-156-12></a><span class=n>template_str</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-156-13 name=__codelineno-156-13 href=#__codelineno-156-13></a><span class=s2> {</span><span class=si>% lo</span><span class=s2>ad component_tags %}</span>
|
||
<a id=__codelineno-156-14 name=__codelineno-156-14 href=#__codelineno-156-14></a><span class=s2> {% provide "my_data" key="hi" another=123 %}</span>
|
||
<a id=__codelineno-156-15 name=__codelineno-156-15 href=#__codelineno-156-15></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent "child" / %}</span>
|
||
<a id=__codelineno-156-16 name=__codelineno-156-16 href=#__codelineno-156-16></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndprovide %}</span>
|
||
<a id=__codelineno-156-17 name=__codelineno-156-17 href=#__codelineno-156-17></a><span class=s2>"""</span>
|
||
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-157-1 name=__codelineno-157-1 href=#__codelineno-157-1></a><span class=p><</span><span class=nt>div</span><span class=p>></span>hi<span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
<a id=__codelineno-157-2 name=__codelineno-157-2 href=#__codelineno-157-2></a><span class=p><</span><span class=nt>div</span><span class=p>></span>123<span class=p></</span><span class=nt>div</span><span class=p>></span>
|
||
</code></pre></div> <h2 id=component-hooks>Component hooks<a class=headerlink href=#component-hooks title="Permanent link">¤</a></h2> <p><em>New in version 0.96</em></p> <p>Component hooks are functions that allow you to intercept the rendering process at specific positions.</p> <h3 id=available-hooks>Available hooks<a class=headerlink href=#available-hooks title="Permanent link">¤</a></h3> <ul> <li><code>on_render_before</code></li> </ul> <div class=highlight><pre><span></span><code><a id=__codelineno-158-1 name=__codelineno-158-1 href=#__codelineno-158-1></a><span class=k>def</span> <span class=nf>on_render_before</span><span class=p>(</span>
|
||
<a id=__codelineno-158-2 name=__codelineno-158-2 href=#__codelineno-158-2></a> <span class=bp>self</span><span class=p>:</span> <span class=n>Component</span><span class=p>,</span>
|
||
<a id=__codelineno-158-3 name=__codelineno-158-3 href=#__codelineno-158-3></a> <span class=n>context</span><span class=p>:</span> <span class=n>Context</span><span class=p>,</span>
|
||
<a id=__codelineno-158-4 name=__codelineno-158-4 href=#__codelineno-158-4></a> <span class=n>template</span><span class=p>:</span> <span class=n>Template</span>
|
||
<a id=__codelineno-158-5 name=__codelineno-158-5 href=#__codelineno-158-5></a><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||
</code></pre></div> <div class=codehilite><pre><span></span><code><span class=n>Hook</span><span class=w> </span><span class=n>that</span><span class=w> </span><span class=n>runs</span><span class=w> </span><span class=n>just</span><span class=w> </span><span class=kr>before</span><span class=w> </span><span class=n>the</span><span class=w> </span><span class=n>component</span><span class=s>'s template is rendered.</span>
|
||
|
||
<span class=s>You can use this hook to access or modify the context or the template:</span>
|
||
|
||
<span class=s>```py</span>
|
||
<span class=s>def on_render_before(self, context, template) -> None:</span>
|
||
<span class=s> # Insert value into the Context</span>
|
||
<span class=s> context["</span><span class=n>from_on_before</span><span class=s>"] = "</span><span class=o>:</span><span class=p>)</span><span class=s>"</span>
|
||
|
||
<span class=s> # Append text into the Template</span>
|
||
<span class=s> template.nodelist.append(TextNode("</span><span class=n>FROM_ON_BEFORE</span><span class=s>"))</span>
|
||
<span class=s>```</span>
|
||
</code></pre></div> <ul> <li><code>on_render_after</code></li> </ul> <div class=highlight><pre><span></span><code><a id=__codelineno-160-1 name=__codelineno-160-1 href=#__codelineno-160-1></a><span class=k>def</span> <span class=nf>on_render_after</span><span class=p>(</span>
|
||
<a id=__codelineno-160-2 name=__codelineno-160-2 href=#__codelineno-160-2></a> <span class=bp>self</span><span class=p>:</span> <span class=n>Component</span><span class=p>,</span>
|
||
<a id=__codelineno-160-3 name=__codelineno-160-3 href=#__codelineno-160-3></a> <span class=n>context</span><span class=p>:</span> <span class=n>Context</span><span class=p>,</span>
|
||
<a id=__codelineno-160-4 name=__codelineno-160-4 href=#__codelineno-160-4></a> <span class=n>template</span><span class=p>:</span> <span class=n>Template</span><span class=p>,</span>
|
||
<a id=__codelineno-160-5 name=__codelineno-160-5 href=#__codelineno-160-5></a> <span class=n>content</span><span class=p>:</span> <span class=nb>str</span>
|
||
<a id=__codelineno-160-6 name=__codelineno-160-6 href=#__codelineno-160-6></a><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span> <span class=o>|</span> <span class=nb>str</span> <span class=o>|</span> <span class=n>SafeString</span><span class=p>:</span>
|
||
</code></pre></div> <div class=codehilite><pre><span></span><code>Hook that runs just after the component's template was rendered.
|
||
It receives the rendered output as the last argument.
|
||
|
||
You can use this hook to access the context or the template, but modifying
|
||
them won't have any effect.
|
||
|
||
To override the content that gets rendered, you can return a string or SafeString from this hook:
|
||
|
||
```py
|
||
def on_render_after(self, context, template, content):
|
||
# Prepend text to the rendered content
|
||
return "Chocolate cookie recipe: " + content
|
||
```
|
||
</code></pre></div> <h3 id=component-hooks-example>Component hooks example<a class=headerlink href=#component-hooks-example title="Permanent link">¤</a></h3> <p>You can use hooks together with <a href=#how-to-use-provide--inject>provide / inject</a> to create components that accept a list of items via a slot.</p> <p>In the example below, each <code>tab_item</code> component will be rendered on a separate tab page, but they are all defined in the default slot of the <code>tabs</code> component.</p> <p><a href=https://github.com/EmilStenstrom/django-components/discussions/540>See here for how it was done</a></p> <div class=highlight><pre><span></span><code><a id=__codelineno-162-1 name=__codelineno-162-1 href=#__codelineno-162-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"tabs"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-2 name=__codelineno-162-2 href=#__codelineno-162-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"tab_item"</span> <span class=nv>header</span><span class=o>=</span><span class=s2>"Tab 1"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-3 name=__codelineno-162-3 href=#__codelineno-162-3></a><span class=x> <p></span>
|
||
<a id=__codelineno-162-4 name=__codelineno-162-4 href=#__codelineno-162-4></a><span class=x> hello from tab 1</span>
|
||
<a id=__codelineno-162-5 name=__codelineno-162-5 href=#__codelineno-162-5></a><span class=x> </p></span>
|
||
<a id=__codelineno-162-6 name=__codelineno-162-6 href=#__codelineno-162-6></a><span class=x> </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-7 name=__codelineno-162-7 href=#__codelineno-162-7></a><span class=x> Click me!</span>
|
||
<a id=__codelineno-162-8 name=__codelineno-162-8 href=#__codelineno-162-8></a><span class=x> </span><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-9 name=__codelineno-162-9 href=#__codelineno-162-9></a><span class=x> </span><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-10 name=__codelineno-162-10 href=#__codelineno-162-10></a>
|
||
<a id=__codelineno-162-11 name=__codelineno-162-11 href=#__codelineno-162-11></a><span class=x> </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"tab_item"</span> <span class=nv>header</span><span class=o>=</span><span class=s2>"Tab 2"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-12 name=__codelineno-162-12 href=#__codelineno-162-12></a><span class=x> Hello this is tab 2</span>
|
||
<a id=__codelineno-162-13 name=__codelineno-162-13 href=#__codelineno-162-13></a><span class=x> </span><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-162-14 name=__codelineno-162-14 href=#__codelineno-162-14></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h2 id=component-context-and-scope>Component context and scope<a class=headerlink href=#component-context-and-scope title="Permanent link">¤</a></h2> <p>By default, context variables are passed down the template as in regular Django - deeper scopes can access the variables from the outer scopes. So if you have several nested forloops, then inside the deep-most loop you can access variables defined by all previous loops.</p> <p>With this in mind, the <code>{% component %}</code> tag behaves similarly to <code>{% include %}</code> tag - inside the component tag, you can access all variables that were defined outside of it.</p> <p>And just like with <code>{% include %}</code>, if you don't want a specific component template to have access to the parent context, add <code>only</code> to the <code>{% component %}</code> tag:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-163-1 name=__codelineno-163-1 href=#__codelineno-163-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calendar"</span> <span class=nv>date</span><span class=o>=</span><span class=s2>"2015-06-19"</span> <span class=nv>only</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>NOTE: <code>{% csrf_token %}</code> tags need access to the top-level context, and they will not function properly if they are rendered in a component that is called with the <code>only</code> modifier.</p> <p>If you find yourself using the <code>only</code> modifier often, you can set the <a href=#context-behavior>context_behavior</a> option to <code>"isolated"</code>, which automatically applies the <code>only</code> modifier. This is useful if you want to make sure that components don't accidentally access the outer context.</p> <p>Components can also access the outer context in their context methods like <code>get_context_data</code> by accessing the property <code>self.outer_context</code>.</p> <h3 id=example-of-accessing-outer-context>Example of Accessing Outer Context<a class=headerlink href=#example-of-accessing-outer-context title="Permanent link">¤</a></h3> <div class=highlight><pre><span></span><code><a id=__codelineno-164-1 name=__codelineno-164-1 href=#__codelineno-164-1></a><span class=x><div></span>
|
||
<a id=__codelineno-164-2 name=__codelineno-164-2 href=#__codelineno-164-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"calender"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-164-3 name=__codelineno-164-3 href=#__codelineno-164-3></a><span class=x></div></span>
|
||
</code></pre></div> <p>Assuming that the rendering context has variables such as <code>date</code>, you can use <code>self.outer_context</code> to access them from within <code>get_context_data</code>. Here's how you might implement it:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-165-1 name=__codelineno-165-1 href=#__codelineno-165-1></a><span class=k>class</span> <span class=nc>Calender</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-165-2 name=__codelineno-165-2 href=#__codelineno-165-2></a>
|
||
<a id=__codelineno-165-3 name=__codelineno-165-3 href=#__codelineno-165-3></a> <span class=o>...</span>
|
||
<a id=__codelineno-165-4 name=__codelineno-165-4 href=#__codelineno-165-4></a>
|
||
<a id=__codelineno-165-5 name=__codelineno-165-5 href=#__codelineno-165-5></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-165-6 name=__codelineno-165-6 href=#__codelineno-165-6></a> <span class=n>outer_field</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>outer_context</span><span class=p>[</span><span class=s2>"date"</span><span class=p>]</span>
|
||
<a id=__codelineno-165-7 name=__codelineno-165-7 href=#__codelineno-165-7></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-165-8 name=__codelineno-165-8 href=#__codelineno-165-8></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>outer_fields</span><span class=p>,</span>
|
||
<a id=__codelineno-165-9 name=__codelineno-165-9 href=#__codelineno-165-9></a> <span class=p>}</span>
|
||
</code></pre></div> <p>However, as a best practice, it’s recommended not to rely on accessing the outer context directly through <code>self.outer_context</code>. Instead, explicitly pass the variables to the component. For instance, continue passing the variables in the component tag as shown in the previous examples.</p> <h2 id=pre-defined-template-variables>Pre-defined template variables<a class=headerlink href=#pre-defined-template-variables title="Permanent link">¤</a></h2> <p>Here is a list of all variables that are automatically available from within the component's template and <code>on_render_before</code> / <code>on_render_after</code> hooks.</p> <ul> <li> <p><code>component_vars.is_filled</code></p> <p><em>New in version 0.70</em></p> <p>Dictonary describing which slots are filled (<code>True</code>) or are not (<code>False</code>).</p> <p>Example:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-166-1 name=__codelineno-166-1 href=#__codelineno-166-1></a><span class=cp>{%</span> <span class=k>if</span> <span class=nv>component_vars.is_filled.my_slot</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-166-2 name=__codelineno-166-2 href=#__codelineno-166-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>slot</span> <span class=s2>"my_slot"</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-166-3 name=__codelineno-166-3 href=#__codelineno-166-3></a><span class=cp>{%</span> <span class=k>endif</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>This is equivalent to checking if a given key is among the slot fills:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-167-1 name=__codelineno-167-1 href=#__codelineno-167-1></a><span class=k>class</span> <span class=nc>MyTable</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-167-2 name=__codelineno-167-2 href=#__codelineno-167-2></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
|
||
<a id=__codelineno-167-3 name=__codelineno-167-3 href=#__codelineno-167-3></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-167-4 name=__codelineno-167-4 href=#__codelineno-167-4></a> <span class=s2>"my_slot_filled"</span><span class=p>:</span> <span class=s2>"my_slot"</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>input</span><span class=o>.</span><span class=n>slots</span>
|
||
<a id=__codelineno-167-5 name=__codelineno-167-5 href=#__codelineno-167-5></a> <span class=p>}</span>
|
||
</code></pre></div> </li> </ul> <h2 id=customizing-component-tags-with-tagformatter>Customizing component tags with TagFormatter<a class=headerlink href=#customizing-component-tags-with-tagformatter title="Permanent link">¤</a></h2> <p><em>New in version 0.89</em></p> <p>By default, components are rendered using the pair of <code>{% component %}</code> / <code>{% endcomponent %}</code> template tags:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-168-1 name=__codelineno-168-1 href=#__codelineno-168-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=nv>disabled</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-168-2 name=__codelineno-168-2 href=#__codelineno-168-2></a><span class=x>Click me!</span>
|
||
<a id=__codelineno-168-3 name=__codelineno-168-3 href=#__codelineno-168-3></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-168-4 name=__codelineno-168-4 href=#__codelineno-168-4></a>
|
||
<a id=__codelineno-168-5 name=__codelineno-168-5 href=#__codelineno-168-5></a><span class=c>{# or #}</span>
|
||
<a id=__codelineno-168-6 name=__codelineno-168-6 href=#__codelineno-168-6></a>
|
||
<a id=__codelineno-168-7 name=__codelineno-168-7 href=#__codelineno-168-7></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=nv>disabled</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>You can change this behaviour in the settings under the <a href=#tag-formatter-setting><code>COMPONENTS.tag_formatter</code></a>.</p> <p>For example, if you set the tag formatter to <code>django_components.component_shorthand_formatter</code>, the components will use their name as the template tags:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-169-1 name=__codelineno-169-1 href=#__codelineno-169-1></a><span class=cp>{%</span> <span class=k>button</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=nv>disabled</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-169-2 name=__codelineno-169-2 href=#__codelineno-169-2></a><span class=x> Click me!</span>
|
||
<a id=__codelineno-169-3 name=__codelineno-169-3 href=#__codelineno-169-3></a><span class=cp>{%</span> <span class=k>endbutton</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-169-4 name=__codelineno-169-4 href=#__codelineno-169-4></a>
|
||
<a id=__codelineno-169-5 name=__codelineno-169-5 href=#__codelineno-169-5></a><span class=c>{# or #}</span>
|
||
<a id=__codelineno-169-6 name=__codelineno-169-6 href=#__codelineno-169-6></a>
|
||
<a id=__codelineno-169-7 name=__codelineno-169-7 href=#__codelineno-169-7></a><span class=cp>{%</span> <span class=k>button</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=nv>disabled</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div> <h3 id=available-tagformatters>Available TagFormatters<a class=headerlink href=#available-tagformatters title="Permanent link">¤</a></h3> <p>django_components provides following predefined TagFormatters:</p> <ul> <li> <p><strong><code>ComponentFormatter</code> (<code>django_components.component_formatter</code>)</strong></p> <p>Default</p> <p>Uses the <code>component</code> and <code>endcomponent</code> tags, and the component name is gives as the first positional argument.</p> <p>Example as block: <div class=highlight><pre><span></span><code><a id=__codelineno-170-1 name=__codelineno-170-1 href=#__codelineno-170-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-170-2 name=__codelineno-170-2 href=#__codelineno-170-2></a><span class=x> </span><span class=cp>{%</span> <span class=k>fill</span> <span class=s2>"content"</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-170-3 name=__codelineno-170-3 href=#__codelineno-170-3></a><span class=x> ...</span>
|
||
<a id=__codelineno-170-4 name=__codelineno-170-4 href=#__codelineno-170-4></a><span class=x> </span><span class=cp>{%</span> <span class=k>endfill</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-170-5 name=__codelineno-170-5 href=#__codelineno-170-5></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div></p> <p>Example as inlined tag: <div class=highlight><pre><span></span><code><a id=__codelineno-171-1 name=__codelineno-171-1 href=#__codelineno-171-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"button"</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div></p> </li> <li> <p><strong><code>ShorthandComponentFormatter</code> (<code>django_components.component_shorthand_formatter</code>)</strong></p> <p>Uses the component name as start tag, and <code>end<component_name></code> as an end tag.</p> <p>Example as block: <div class=highlight><pre><span></span><code><a id=__codelineno-172-1 name=__codelineno-172-1 href=#__codelineno-172-1></a><span class=cp>{%</span> <span class=k>button</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-172-2 name=__codelineno-172-2 href=#__codelineno-172-2></a><span class=x> Click me!</span>
|
||
<a id=__codelineno-172-3 name=__codelineno-172-3 href=#__codelineno-172-3></a><span class=cp>{%</span> <span class=k>endbutton</span> <span class=cp>%}</span>
|
||
</code></pre></div></p> <p>Example as inlined tag: <div class=highlight><pre><span></span><code><a id=__codelineno-173-1 name=__codelineno-173-1 href=#__codelineno-173-1></a><span class=cp>{%</span> <span class=k>button</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=o>/</span> <span class=cp>%}</span>
|
||
</code></pre></div></p> </li> </ul> <h3 id=writing-your-own-tagformatter>Writing your own TagFormatter<a class=headerlink href=#writing-your-own-tagformatter title="Permanent link">¤</a></h3> <h4 id=background>Background<a class=headerlink href=#background title="Permanent link">¤</a></h4> <p>First, let's discuss how TagFormatters work, and how components are rendered in django_components.</p> <p>When you render a component with <code>{% component %}</code> (or your own tag), the following happens: 1. <code>component</code> must be registered as a Django's template tag 2. Django triggers django_components's tag handler for tag <code>component</code>. 3. The tag handler passes the tag contents for pre-processing to <code>TagFormatter.parse()</code>.</p> <div class=codehilite><pre><span></span><code><span class=nv>So</span><span class=w> </span><span class=k>if</span><span class=w> </span><span class=nv>you</span><span class=w> </span><span class=nv>render</span><span class=w> </span><span class=nv>this</span>:
|
||
```<span class=nv>django</span>
|
||
{<span class=o>%</span><span class=w> </span><span class=nv>component</span><span class=w> </span><span class=s2>"button"</span><span class=w> </span><span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span><span class=w> </span><span class=nv>disabled</span><span class=w> </span><span class=o>%</span>}
|
||
{<span class=o>%</span><span class=w> </span><span class=nv>endcomponent</span><span class=w> </span><span class=o>%</span>}
|
||
```
|
||
|
||
<span class=k>Then</span><span class=w> </span>`<span class=nv>TagFormatter</span>.<span class=nv>parse</span><span class=ss>()</span>`<span class=w> </span><span class=nv>will</span><span class=w> </span><span class=nv>receive</span><span class=w> </span><span class=nv>a</span><span class=w> </span><span class=nv>following</span><span class=w> </span><span class=nv>input</span>:
|
||
```<span class=nv>py</span>
|
||
[<span class=s2>"component"</span>,<span class=w> </span><span class=s1>'"button"'</span>,<span class=w> </span><span class=s1>'href="..."'</span>,<span class=w> </span><span class=s1>'disabled'</span>]
|
||
```
|
||
</code></pre></div> <ol> <li> <p><code>TagFormatter</code> extracts the component name and the remaining input.</p> <p>So, given the above, <code>TagFormatter.parse()</code> returns the following: <div class=highlight><pre><span></span><code><a id=__codelineno-176-1 name=__codelineno-176-1 href=#__codelineno-176-1></a><span class=n>TagResult</span><span class=p>(</span>
|
||
<a id=__codelineno-176-2 name=__codelineno-176-2 href=#__codelineno-176-2></a> <span class=n>component_name</span><span class=o>=</span><span class=s2>"button"</span><span class=p>,</span>
|
||
<a id=__codelineno-176-3 name=__codelineno-176-3 href=#__codelineno-176-3></a> <span class=n>tokens</span><span class=o>=</span><span class=p>[</span><span class=s1>'href="..."'</span><span class=p>,</span> <span class=s1>'disabled'</span><span class=p>]</span>
|
||
<a id=__codelineno-176-4 name=__codelineno-176-4 href=#__codelineno-176-4></a><span class=p>)</span>
|
||
</code></pre></div> 5. The tag handler resumes, using the tokens returned from <code>TagFormatter</code>.</p> <p>So, continuing the example, at this point the tag handler practically behaves as if you rendered: <div class=highlight><pre><span></span><code><a id=__codelineno-177-1 name=__codelineno-177-1 href=#__codelineno-177-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=nv>href</span><span class=o>=</span><span class=s2>"..."</span> <span class=nv>disabled</span> <span class=cp>%}</span>
|
||
</code></pre></div> 6. Tag handler looks up the component <code>button</code>, and passes the args, kwargs, and slots to it.</p> </li> </ol> <h4 id=tagformatter>TagFormatter<a class=headerlink href=#tagformatter title="Permanent link">¤</a></h4> <p><code>TagFormatter</code> handles following parts of the process above: - Generates start/end tags, given a component. This is what you then call from within your template as <code>{% component %}</code>.</p> <ul> <li>When you <code>{% component %}</code>, tag formatter pre-processes the tag contents, so it can link back the custom template tag to the right component.</li> </ul> <p>To do so, subclass from <code>TagFormatterABC</code> and implement following method: - <code>start_tag</code> - <code>end_tag</code> - <code>parse</code></p> <p>For example, this is the implementation of <a href=#available-tagformatters><code>ShorthandComponentFormatter</code></a></p> <div class=highlight><pre><span></span><code><a id=__codelineno-178-1 name=__codelineno-178-1 href=#__codelineno-178-1></a><span class=k>class</span> <span class=nc>ShorthandComponentFormatter</span><span class=p>(</span><span class=n>TagFormatterABC</span><span class=p>):</span>
|
||
<a id=__codelineno-178-2 name=__codelineno-178-2 href=#__codelineno-178-2></a> <span class=c1># Given a component name, generate the start template tag</span>
|
||
<a id=__codelineno-178-3 name=__codelineno-178-3 href=#__codelineno-178-3></a> <span class=k>def</span> <span class=nf>start_tag</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span> <span class=o>-></span> <span class=nb>str</span><span class=p>:</span>
|
||
<a id=__codelineno-178-4 name=__codelineno-178-4 href=#__codelineno-178-4></a> <span class=k>return</span> <span class=n>name</span> <span class=c1># e.g. 'button'</span>
|
||
<a id=__codelineno-178-5 name=__codelineno-178-5 href=#__codelineno-178-5></a>
|
||
<a id=__codelineno-178-6 name=__codelineno-178-6 href=#__codelineno-178-6></a> <span class=c1># Given a component name, generate the start template tag</span>
|
||
<a id=__codelineno-178-7 name=__codelineno-178-7 href=#__codelineno-178-7></a> <span class=k>def</span> <span class=nf>end_tag</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span> <span class=o>-></span> <span class=nb>str</span><span class=p>:</span>
|
||
<a id=__codelineno-178-8 name=__codelineno-178-8 href=#__codelineno-178-8></a> <span class=k>return</span> <span class=sa>f</span><span class=s2>"end</span><span class=si>{</span><span class=n>name</span><span class=si>}</span><span class=s2>"</span> <span class=c1># e.g. 'endbutton'</span>
|
||
<a id=__codelineno-178-9 name=__codelineno-178-9 href=#__codelineno-178-9></a>
|
||
<a id=__codelineno-178-10 name=__codelineno-178-10 href=#__codelineno-178-10></a> <span class=c1># Given a tag, e.g.</span>
|
||
<a id=__codelineno-178-11 name=__codelineno-178-11 href=#__codelineno-178-11></a> <span class=c1># `{% button href="..." disabled %}`</span>
|
||
<a id=__codelineno-178-12 name=__codelineno-178-12 href=#__codelineno-178-12></a> <span class=c1>#</span>
|
||
<a id=__codelineno-178-13 name=__codelineno-178-13 href=#__codelineno-178-13></a> <span class=c1># The parser receives:</span>
|
||
<a id=__codelineno-178-14 name=__codelineno-178-14 href=#__codelineno-178-14></a> <span class=c1># `['button', 'href="..."', 'disabled']`</span>
|
||
<a id=__codelineno-178-15 name=__codelineno-178-15 href=#__codelineno-178-15></a> <span class=k>def</span> <span class=nf>parse</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>tokens</span><span class=p>:</span> <span class=n>List</span><span class=p>[</span><span class=nb>str</span><span class=p>])</span> <span class=o>-></span> <span class=n>TagResult</span><span class=p>:</span>
|
||
<a id=__codelineno-178-16 name=__codelineno-178-16 href=#__codelineno-178-16></a> <span class=n>tokens</span> <span class=o>=</span> <span class=p>[</span><span class=o>*</span><span class=n>tokens</span><span class=p>]</span>
|
||
<a id=__codelineno-178-17 name=__codelineno-178-17 href=#__codelineno-178-17></a> <span class=n>name</span> <span class=o>=</span> <span class=n>tokens</span><span class=o>.</span><span class=n>pop</span><span class=p>(</span><span class=mi>0</span><span class=p>)</span>
|
||
<a id=__codelineno-178-18 name=__codelineno-178-18 href=#__codelineno-178-18></a> <span class=k>return</span> <span class=n>TagResult</span><span class=p>(</span>
|
||
<a id=__codelineno-178-19 name=__codelineno-178-19 href=#__codelineno-178-19></a> <span class=n>name</span><span class=p>,</span> <span class=c1># e.g. 'button'</span>
|
||
<a id=__codelineno-178-20 name=__codelineno-178-20 href=#__codelineno-178-20></a> <span class=n>tokens</span> <span class=c1># e.g. ['href="..."', 'disabled']</span>
|
||
<a id=__codelineno-178-21 name=__codelineno-178-21 href=#__codelineno-178-21></a> <span class=p>)</span>
|
||
</code></pre></div> <p>That's it! And once your <code>TagFormatter</code> is ready, don't forget to update the settings!</p> <h2 id=defining-htmljscss-files>Defining HTML/JS/CSS files<a class=headerlink href=#defining-htmljscss-files title="Permanent link">¤</a></h2> <p>django_component's management of files builds on top of <a href=https://docs.djangoproject.com/en/5.0/topics/forms/media/ >Django's <code>Media</code> class</a>.</p> <p>To be familiar with how Django handles static files, we recommend reading also:</p> <ul> <li><a href=https://docs.djangoproject.com/en/5.0/howto/static-files/ >How to manage static files (e.g. images, JavaScript, CSS)</a></li> </ul> <h3 id=defining-file-paths-relative-to-component-or-static-dirs>Defining file paths relative to component or static dirs<a class=headerlink href=#defining-file-paths-relative-to-component-or-static-dirs title="Permanent link">¤</a></h3> <p>As seen in the <a href=#create-your-first-component>getting started example</a>, to associate HTML/JS/CSS files with a component, you set them as <code>template_name</code>, <code>Media.js</code> and <code>Media.css</code> respectively:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-179-1 name=__codelineno-179-1 href=#__codelineno-179-1></a><span class=c1># In a file [project root]/components/calendar/calendar.py</span>
|
||
<a id=__codelineno-179-2 name=__codelineno-179-2 href=#__codelineno-179-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-179-3 name=__codelineno-179-3 href=#__codelineno-179-3></a>
|
||
<a id=__codelineno-179-4 name=__codelineno-179-4 href=#__codelineno-179-4></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-179-5 name=__codelineno-179-5 href=#__codelineno-179-5></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-179-6 name=__codelineno-179-6 href=#__codelineno-179-6></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"template.html"</span>
|
||
<a id=__codelineno-179-7 name=__codelineno-179-7 href=#__codelineno-179-7></a>
|
||
<a id=__codelineno-179-8 name=__codelineno-179-8 href=#__codelineno-179-8></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-179-9 name=__codelineno-179-9 href=#__codelineno-179-9></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>"style.css"</span>
|
||
<a id=__codelineno-179-10 name=__codelineno-179-10 href=#__codelineno-179-10></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>"script.js"</span>
|
||
</code></pre></div> <p>In the example above, the files are defined relative to the directory where <code>component.py</code> is.</p> <p>Alternatively, you can specify the file paths relative to the directories set in <code>COMPONENTS.dirs</code> or <code>COMPONENTS.app_dirs</code>.</p> <p>Assuming that <code>COMPONENTS.dirs</code> contains path <code>[project root]/components</code>, we can rewrite the example as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-180-1 name=__codelineno-180-1 href=#__codelineno-180-1></a><span class=c1># In a file [project root]/components/calendar/calendar.py</span>
|
||
<a id=__codelineno-180-2 name=__codelineno-180-2 href=#__codelineno-180-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-180-3 name=__codelineno-180-3 href=#__codelineno-180-3></a>
|
||
<a id=__codelineno-180-4 name=__codelineno-180-4 href=#__codelineno-180-4></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-180-5 name=__codelineno-180-5 href=#__codelineno-180-5></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-180-6 name=__codelineno-180-6 href=#__codelineno-180-6></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"calendar/template.html"</span>
|
||
<a id=__codelineno-180-7 name=__codelineno-180-7 href=#__codelineno-180-7></a>
|
||
<a id=__codelineno-180-8 name=__codelineno-180-8 href=#__codelineno-180-8></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-180-9 name=__codelineno-180-9 href=#__codelineno-180-9></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>"calendar/style.css"</span>
|
||
<a id=__codelineno-180-10 name=__codelineno-180-10 href=#__codelineno-180-10></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>"calendar/script.js"</span>
|
||
</code></pre></div> <p>NOTE: In case of conflict, the preference goes to resolving the files relative to the component's directory.</p> <h3 id=defining-multiple-paths>Defining multiple paths<a class=headerlink href=#defining-multiple-paths title="Permanent link">¤</a></h3> <p>Each component can have only a single template. However, you can define as many JS or CSS files as you want using a list.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-181-1 name=__codelineno-181-1 href=#__codelineno-181-1></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-181-2 name=__codelineno-181-2 href=#__codelineno-181-2></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-181-3 name=__codelineno-181-3 href=#__codelineno-181-3></a> <span class=n>js</span> <span class=o>=</span> <span class=p>[</span><span class=s2>"path/to/script1.js"</span><span class=p>,</span> <span class=s2>"path/to/script2.js"</span><span class=p>]</span>
|
||
<a id=__codelineno-181-4 name=__codelineno-181-4 href=#__codelineno-181-4></a> <span class=n>css</span> <span class=o>=</span> <span class=p>[</span><span class=s2>"path/to/style1.css"</span><span class=p>,</span> <span class=s2>"path/to/style2.css"</span><span class=p>]</span>
|
||
</code></pre></div> <h3 id=configuring-css-media-types>Configuring CSS Media Types<a class=headerlink href=#configuring-css-media-types title="Permanent link">¤</a></h3> <p>You can define which stylesheets will be associated with which <a href=https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries#targeting_media_types>CSS Media types</a>. You do so by defining CSS files as a dictionary.</p> <p>See the corresponding <a href=https://docs.djangoproject.com/en/5.0/topics/forms/media/#css>Django Documentation</a>.</p> <p>Again, you can set either a single file or a list of files per media type:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-182-1 name=__codelineno-182-1 href=#__codelineno-182-1></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-182-2 name=__codelineno-182-2 href=#__codelineno-182-2></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-182-3 name=__codelineno-182-3 href=#__codelineno-182-3></a> <span class=n>css</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-182-4 name=__codelineno-182-4 href=#__codelineno-182-4></a> <span class=s2>"all"</span><span class=p>:</span> <span class=s2>"path/to/style1.css"</span><span class=p>,</span>
|
||
<a id=__codelineno-182-5 name=__codelineno-182-5 href=#__codelineno-182-5></a> <span class=s2>"print"</span><span class=p>:</span> <span class=s2>"path/to/style2.css"</span><span class=p>,</span>
|
||
<a id=__codelineno-182-6 name=__codelineno-182-6 href=#__codelineno-182-6></a> <span class=p>}</span>
|
||
</code></pre></div> <div class=highlight><pre><span></span><code><a id=__codelineno-183-1 name=__codelineno-183-1 href=#__codelineno-183-1></a><span class=k>class</span> <span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-183-2 name=__codelineno-183-2 href=#__codelineno-183-2></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-183-3 name=__codelineno-183-3 href=#__codelineno-183-3></a> <span class=n>css</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-183-4 name=__codelineno-183-4 href=#__codelineno-183-4></a> <span class=s2>"all"</span><span class=p>:</span> <span class=p>[</span><span class=s2>"path/to/style1.css"</span><span class=p>,</span> <span class=s2>"path/to/style2.css"</span><span class=p>],</span>
|
||
<a id=__codelineno-183-5 name=__codelineno-183-5 href=#__codelineno-183-5></a> <span class=s2>"print"</span><span class=p>:</span> <span class=p>[</span><span class=s2>"path/to/style3.css"</span><span class=p>,</span> <span class=s2>"path/to/style4.css"</span><span class=p>],</span>
|
||
<a id=__codelineno-183-6 name=__codelineno-183-6 href=#__codelineno-183-6></a> <span class=p>}</span>
|
||
</code></pre></div> <p>NOTE: When you define CSS as a string or a list, the <code>all</code> media type is implied.</p> <h3 id=supported-types-for-file-paths>Supported types for file paths<a class=headerlink href=#supported-types-for-file-paths title="Permanent link">¤</a></h3> <p>File paths can be any of:</p> <ul> <li><code>str</code></li> <li><code>bytes</code></li> <li><code>PathLike</code> (<code>__fspath__</code> method)</li> <li><code>SafeData</code> (<code>__html__</code> method)</li> <li><code>Callable</code> that returns any of the above, evaluated at class creation (<code>__new__</code>)</li> </ul> <div class=highlight><pre><span></span><code><a id=__codelineno-184-1 name=__codelineno-184-1 href=#__codelineno-184-1></a><span class=kn>from</span> <span class=nn>pathlib</span> <span class=kn>import</span> <span class=n>Path</span>
|
||
<a id=__codelineno-184-2 name=__codelineno-184-2 href=#__codelineno-184-2></a>
|
||
<a id=__codelineno-184-3 name=__codelineno-184-3 href=#__codelineno-184-3></a><span class=kn>from</span> <span class=nn>django.utils.safestring</span> <span class=kn>import</span> <span class=n>mark_safe</span>
|
||
<a id=__codelineno-184-4 name=__codelineno-184-4 href=#__codelineno-184-4></a>
|
||
<a id=__codelineno-184-5 name=__codelineno-184-5 href=#__codelineno-184-5></a><span class=k>class</span> <span class=nc>SimpleComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-184-6 name=__codelineno-184-6 href=#__codelineno-184-6></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-184-7 name=__codelineno-184-7 href=#__codelineno-184-7></a> <span class=n>css</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-184-8 name=__codelineno-184-8 href=#__codelineno-184-8></a> <span class=n>mark_safe</span><span class=p>(</span><span class=s1>'<link href="/static/calendar/style.css" rel="stylesheet" />'</span><span class=p>),</span>
|
||
<a id=__codelineno-184-9 name=__codelineno-184-9 href=#__codelineno-184-9></a> <span class=n>Path</span><span class=p>(</span><span class=s2>"calendar/style1.css"</span><span class=p>),</span>
|
||
<a id=__codelineno-184-10 name=__codelineno-184-10 href=#__codelineno-184-10></a> <span class=s2>"calendar/style2.css"</span><span class=p>,</span>
|
||
<a id=__codelineno-184-11 name=__codelineno-184-11 href=#__codelineno-184-11></a> <span class=sa>b</span><span class=s2>"calendar/style3.css"</span><span class=p>,</span>
|
||
<a id=__codelineno-184-12 name=__codelineno-184-12 href=#__codelineno-184-12></a> <span class=k>lambda</span><span class=p>:</span> <span class=s2>"calendar/style4.css"</span><span class=p>,</span>
|
||
<a id=__codelineno-184-13 name=__codelineno-184-13 href=#__codelineno-184-13></a> <span class=p>]</span>
|
||
<a id=__codelineno-184-14 name=__codelineno-184-14 href=#__codelineno-184-14></a> <span class=n>js</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-184-15 name=__codelineno-184-15 href=#__codelineno-184-15></a> <span class=n>mark_safe</span><span class=p>(</span><span class=s1>'<script src="/static/calendar/script.js"></script>'</span><span class=p>),</span>
|
||
<a id=__codelineno-184-16 name=__codelineno-184-16 href=#__codelineno-184-16></a> <span class=n>Path</span><span class=p>(</span><span class=s2>"calendar/script1.js"</span><span class=p>),</span>
|
||
<a id=__codelineno-184-17 name=__codelineno-184-17 href=#__codelineno-184-17></a> <span class=s2>"calendar/script2.js"</span><span class=p>,</span>
|
||
<a id=__codelineno-184-18 name=__codelineno-184-18 href=#__codelineno-184-18></a> <span class=sa>b</span><span class=s2>"calendar/script3.js"</span><span class=p>,</span>
|
||
<a id=__codelineno-184-19 name=__codelineno-184-19 href=#__codelineno-184-19></a> <span class=k>lambda</span><span class=p>:</span> <span class=s2>"calendar/script4.js"</span><span class=p>,</span>
|
||
<a id=__codelineno-184-20 name=__codelineno-184-20 href=#__codelineno-184-20></a> <span class=p>]</span>
|
||
</code></pre></div> <h3 id=path-as-objects>Path as objects<a class=headerlink href=#path-as-objects title="Permanent link">¤</a></h3> <p>In the example <a href=#supported-types-for-file-paths>above</a>, you could see that when we used <code>mark_safe</code> to mark a string as a <code>SafeString</code>, we had to define the full <code><script></code>/<code><link></code> tag.</p> <p>This is an extension of Django's <a href=https://docs.djangoproject.com/en/5.0/topics/forms/media/#paths-as-objects>Paths as objects</a> feature, where "safe" strings are taken as is, and accessed only at render time.</p> <p>Because of that, the paths defined as "safe" strings are NEVER resolved, neither relative to component's directory, nor relative to <code>COMPONENTS.dirs</code>.</p> <p>"Safe" strings can be used to lazily resolve a path, or to customize the <code><script></code> or <code><link></code> tag for individual paths:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-185-1 name=__codelineno-185-1 href=#__codelineno-185-1></a><span class=k>class</span> <span class=nc>LazyJsPath</span><span class=p>:</span>
|
||
<a id=__codelineno-185-2 name=__codelineno-185-2 href=#__codelineno-185-2></a> <span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>static_path</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||
<a id=__codelineno-185-3 name=__codelineno-185-3 href=#__codelineno-185-3></a> <span class=bp>self</span><span class=o>.</span><span class=n>static_path</span> <span class=o>=</span> <span class=n>static_path</span>
|
||
<a id=__codelineno-185-4 name=__codelineno-185-4 href=#__codelineno-185-4></a>
|
||
<a id=__codelineno-185-5 name=__codelineno-185-5 href=#__codelineno-185-5></a> <span class=k>def</span> <span class=nf>__html__</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-185-6 name=__codelineno-185-6 href=#__codelineno-185-6></a> <span class=n>full_path</span> <span class=o>=</span> <span class=n>static</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>static_path</span><span class=p>)</span>
|
||
<a id=__codelineno-185-7 name=__codelineno-185-7 href=#__codelineno-185-7></a> <span class=k>return</span> <span class=n>format_html</span><span class=p>(</span>
|
||
<a id=__codelineno-185-8 name=__codelineno-185-8 href=#__codelineno-185-8></a> <span class=sa>f</span><span class=s1>'<script type="module" src="</span><span class=si>{</span><span class=n>full_path</span><span class=si>}</span><span class=s1>"></script>'</span>
|
||
<a id=__codelineno-185-9 name=__codelineno-185-9 href=#__codelineno-185-9></a> <span class=p>)</span>
|
||
<a id=__codelineno-185-10 name=__codelineno-185-10 href=#__codelineno-185-10></a>
|
||
<a id=__codelineno-185-11 name=__codelineno-185-11 href=#__codelineno-185-11></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-185-12 name=__codelineno-185-12 href=#__codelineno-185-12></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-185-13 name=__codelineno-185-13 href=#__codelineno-185-13></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"calendar/template.html"</span>
|
||
<a id=__codelineno-185-14 name=__codelineno-185-14 href=#__codelineno-185-14></a>
|
||
<a id=__codelineno-185-15 name=__codelineno-185-15 href=#__codelineno-185-15></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>date</span><span class=p>):</span>
|
||
<a id=__codelineno-185-16 name=__codelineno-185-16 href=#__codelineno-185-16></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-185-17 name=__codelineno-185-17 href=#__codelineno-185-17></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
||
<a id=__codelineno-185-18 name=__codelineno-185-18 href=#__codelineno-185-18></a> <span class=p>}</span>
|
||
<a id=__codelineno-185-19 name=__codelineno-185-19 href=#__codelineno-185-19></a>
|
||
<a id=__codelineno-185-20 name=__codelineno-185-20 href=#__codelineno-185-20></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-185-21 name=__codelineno-185-21 href=#__codelineno-185-21></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>"calendar/style.css"</span>
|
||
<a id=__codelineno-185-22 name=__codelineno-185-22 href=#__codelineno-185-22></a> <span class=n>js</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-185-23 name=__codelineno-185-23 href=#__codelineno-185-23></a> <span class=c1># <script> tag constructed by Media class</span>
|
||
<a id=__codelineno-185-24 name=__codelineno-185-24 href=#__codelineno-185-24></a> <span class=s2>"calendar/script1.js"</span><span class=p>,</span>
|
||
<a id=__codelineno-185-25 name=__codelineno-185-25 href=#__codelineno-185-25></a> <span class=c1># Custom <script> tag</span>
|
||
<a id=__codelineno-185-26 name=__codelineno-185-26 href=#__codelineno-185-26></a> <span class=n>LazyJsPath</span><span class=p>(</span><span class=s2>"calendar/script2.js"</span><span class=p>),</span>
|
||
<a id=__codelineno-185-27 name=__codelineno-185-27 href=#__codelineno-185-27></a> <span class=p>]</span>
|
||
</code></pre></div> <h3 id=customize-how-paths-are-rendered-into-html-tags-with-media_class>Customize how paths are rendered into HTML tags with <code>media_class</code><a class=headerlink href=#customize-how-paths-are-rendered-into-html-tags-with-media_class title="Permanent link">¤</a></h3> <p>Sometimes you may need to change how all CSS <code><link></code> or JS <code><script></code> tags are rendered for a given component. You can achieve this by providing your own subclass of <a href=https://docs.djangoproject.com/en/5.0/topics/forms/media>Django's <code>Media</code> class</a> to component's <code>media_class</code> attribute.</p> <p>Normally, the JS and CSS paths are passed to <code>Media</code> class, which decides how the paths are resolved and how the <code><link></code> and <code><script></code> tags are constructed.</p> <p>To change how the tags are constructed, you can override the <a href=https://github.com/django/django/blob/fa7848146738a9fe1d415ee4808664e54739eeb7/django/forms/widgets.py#L102><code>Media.render_js</code> and <code>Media.render_css</code> methods</a>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-186-1 name=__codelineno-186-1 href=#__codelineno-186-1></a><span class=kn>from</span> <span class=nn>django.forms.widgets</span> <span class=kn>import</span> <span class=n>Media</span>
|
||
<a id=__codelineno-186-2 name=__codelineno-186-2 href=#__codelineno-186-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>register</span>
|
||
<a id=__codelineno-186-3 name=__codelineno-186-3 href=#__codelineno-186-3></a>
|
||
<a id=__codelineno-186-4 name=__codelineno-186-4 href=#__codelineno-186-4></a><span class=k>class</span> <span class=nc>MyMedia</span><span class=p>(</span><span class=n>Media</span><span class=p>):</span>
|
||
<a id=__codelineno-186-5 name=__codelineno-186-5 href=#__codelineno-186-5></a> <span class=c1># Same as original Media.render_js, except</span>
|
||
<a id=__codelineno-186-6 name=__codelineno-186-6 href=#__codelineno-186-6></a> <span class=c1># the `<script>` tag has also `type="module"`</span>
|
||
<a id=__codelineno-186-7 name=__codelineno-186-7 href=#__codelineno-186-7></a> <span class=k>def</span> <span class=nf>render_js</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-186-8 name=__codelineno-186-8 href=#__codelineno-186-8></a> <span class=n>tags</span> <span class=o>=</span> <span class=p>[]</span>
|
||
<a id=__codelineno-186-9 name=__codelineno-186-9 href=#__codelineno-186-9></a> <span class=k>for</span> <span class=n>path</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>_js</span><span class=p>:</span>
|
||
<a id=__codelineno-186-10 name=__codelineno-186-10 href=#__codelineno-186-10></a> <span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>path</span><span class=p>,</span> <span class=s2>"__html__"</span><span class=p>):</span>
|
||
<a id=__codelineno-186-11 name=__codelineno-186-11 href=#__codelineno-186-11></a> <span class=n>tag</span> <span class=o>=</span> <span class=n>path</span><span class=o>.</span><span class=n>__html__</span><span class=p>()</span>
|
||
<a id=__codelineno-186-12 name=__codelineno-186-12 href=#__codelineno-186-12></a> <span class=k>else</span><span class=p>:</span>
|
||
<a id=__codelineno-186-13 name=__codelineno-186-13 href=#__codelineno-186-13></a> <span class=n>tag</span> <span class=o>=</span> <span class=n>format_html</span><span class=p>(</span>
|
||
<a id=__codelineno-186-14 name=__codelineno-186-14 href=#__codelineno-186-14></a> <span class=s1>'<script type="module" src="</span><span class=si>{}</span><span class=s1>"></script>'</span><span class=p>,</span>
|
||
<a id=__codelineno-186-15 name=__codelineno-186-15 href=#__codelineno-186-15></a> <span class=bp>self</span><span class=o>.</span><span class=n>absolute_path</span><span class=p>(</span><span class=n>path</span><span class=p>)</span>
|
||
<a id=__codelineno-186-16 name=__codelineno-186-16 href=#__codelineno-186-16></a> <span class=p>)</span>
|
||
<a id=__codelineno-186-17 name=__codelineno-186-17 href=#__codelineno-186-17></a> <span class=k>return</span> <span class=n>tags</span>
|
||
<a id=__codelineno-186-18 name=__codelineno-186-18 href=#__codelineno-186-18></a>
|
||
<a id=__codelineno-186-19 name=__codelineno-186-19 href=#__codelineno-186-19></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"calendar"</span><span class=p>)</span>
|
||
<a id=__codelineno-186-20 name=__codelineno-186-20 href=#__codelineno-186-20></a><span class=k>class</span> <span class=nc>Calendar</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-186-21 name=__codelineno-186-21 href=#__codelineno-186-21></a> <span class=n>template_name</span> <span class=o>=</span> <span class=s2>"calendar/template.html"</span>
|
||
<a id=__codelineno-186-22 name=__codelineno-186-22 href=#__codelineno-186-22></a>
|
||
<a id=__codelineno-186-23 name=__codelineno-186-23 href=#__codelineno-186-23></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-186-24 name=__codelineno-186-24 href=#__codelineno-186-24></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>"calendar/style.css"</span>
|
||
<a id=__codelineno-186-25 name=__codelineno-186-25 href=#__codelineno-186-25></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>"calendar/script.js"</span>
|
||
<a id=__codelineno-186-26 name=__codelineno-186-26 href=#__codelineno-186-26></a>
|
||
<a id=__codelineno-186-27 name=__codelineno-186-27 href=#__codelineno-186-27></a> <span class=c1># Override the behavior of Media class</span>
|
||
<a id=__codelineno-186-28 name=__codelineno-186-28 href=#__codelineno-186-28></a> <span class=n>media_class</span> <span class=o>=</span> <span class=n>MyMedia</span>
|
||
</code></pre></div> <p>NOTE: The instance of the <code>Media</code> class (or it's subclass) is available under <code>Component.media</code> after the class creation (<code>__new__</code>).</p> <h2 id=rendering-jscss-dependencies>Rendering JS/CSS dependencies<a class=headerlink href=#rendering-jscss-dependencies title="Permanent link">¤</a></h2> <p>If: 1. Your components use JS and CSS, whether inlined via <code>Component.js/css</code> or via <code>Component.Media.js/css</code>, 2. And you use the <code>ComponentDependencyMiddleware</code> middleware</p> <p>Then, by default, the components' JS and CSS will be automatically inserted into the HTML: - CSS styles will be inserted at the end of the <code><head></code> - JS scripts will be inserted at the end of the <code><body></code></p> <p>If you want to place the dependencies elsewhere, you can override that with following Django template tags:</p> <ul> <li><code>{% component_js_dependencies %}</code> - Renders only JS</li> <li><code>{% component_css_dependencies %}</code> - Renders only CSS</li> </ul> <p>So if you have a component with JS and CSS:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-187-1 name=__codelineno-187-1 href=#__codelineno-187-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>types</span>
|
||
<a id=__codelineno-187-2 name=__codelineno-187-2 href=#__codelineno-187-2></a>
|
||
<a id=__codelineno-187-3 name=__codelineno-187-3 href=#__codelineno-187-3></a><span class=k>class</span> <span class=nc>MyButton</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-187-4 name=__codelineno-187-4 href=#__codelineno-187-4></a> <span class=n>template</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>django_html</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-187-5 name=__codelineno-187-5 href=#__codelineno-187-5></a><span class=s2> <button class="my-button"></span>
|
||
<a id=__codelineno-187-6 name=__codelineno-187-6 href=#__codelineno-187-6></a><span class=s2> Click me!</span>
|
||
<a id=__codelineno-187-7 name=__codelineno-187-7 href=#__codelineno-187-7></a><span class=s2> </button></span>
|
||
<a id=__codelineno-187-8 name=__codelineno-187-8 href=#__codelineno-187-8></a><span class=s2> """</span>
|
||
<a id=__codelineno-187-9 name=__codelineno-187-9 href=#__codelineno-187-9></a> <span class=n>js</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>js</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-187-10 name=__codelineno-187-10 href=#__codelineno-187-10></a><span class=s2> for (const btnEl of document.querySelectorAll(".my-button")) {</span>
|
||
<a id=__codelineno-187-11 name=__codelineno-187-11 href=#__codelineno-187-11></a><span class=s2> btnEl.addEventListener("click", () => {</span>
|
||
<a id=__codelineno-187-12 name=__codelineno-187-12 href=#__codelineno-187-12></a><span class=s2> console.log("BUTTON CLICKED!");</span>
|
||
<a id=__codelineno-187-13 name=__codelineno-187-13 href=#__codelineno-187-13></a><span class=s2> });</span>
|
||
<a id=__codelineno-187-14 name=__codelineno-187-14 href=#__codelineno-187-14></a><span class=s2> }</span>
|
||
<a id=__codelineno-187-15 name=__codelineno-187-15 href=#__codelineno-187-15></a><span class=s2> """</span>
|
||
<a id=__codelineno-187-16 name=__codelineno-187-16 href=#__codelineno-187-16></a> <span class=n>css</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>css</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-187-17 name=__codelineno-187-17 href=#__codelineno-187-17></a><span class=s2> .my-button {</span>
|
||
<a id=__codelineno-187-18 name=__codelineno-187-18 href=#__codelineno-187-18></a><span class=s2> background: green;</span>
|
||
<a id=__codelineno-187-19 name=__codelineno-187-19 href=#__codelineno-187-19></a><span class=s2> }</span>
|
||
<a id=__codelineno-187-20 name=__codelineno-187-20 href=#__codelineno-187-20></a><span class=s2> """</span>
|
||
<a id=__codelineno-187-21 name=__codelineno-187-21 href=#__codelineno-187-21></a>
|
||
<a id=__codelineno-187-22 name=__codelineno-187-22 href=#__codelineno-187-22></a> <span class=k>class</span> <span class=nc>Media</span><span class=p>:</span>
|
||
<a id=__codelineno-187-23 name=__codelineno-187-23 href=#__codelineno-187-23></a> <span class=n>js</span> <span class=o>=</span> <span class=p>[</span><span class=s2>"/extra/script.js"</span><span class=p>]</span>
|
||
<a id=__codelineno-187-24 name=__codelineno-187-24 href=#__codelineno-187-24></a> <span class=n>css</span> <span class=o>=</span> <span class=p>[</span><span class=s2>"/extra/style.css"</span><span class=p>]</span>
|
||
</code></pre></div> <p>Then the inlined JS and the scripts in <code>Media.js</code> will be rendered at the default place, or in <code>{% component_js_dependencies %}</code>.</p> <p>And the inlined CSS and the styles in <code>Media.css</code> will be rendered at the default place, or in <code>{% component_css_dependencies %}</code>.</p> <p>And if you don't specify <code>{% component_dependencies %}</code> tags, it is the equivalent of:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-188-1 name=__codelineno-188-1 href=#__codelineno-188-1></a><span class=x><!doctype html></span>
|
||
<a id=__codelineno-188-2 name=__codelineno-188-2 href=#__codelineno-188-2></a><span class=x><html></span>
|
||
<a id=__codelineno-188-3 name=__codelineno-188-3 href=#__codelineno-188-3></a><span class=x> <head></span>
|
||
<a id=__codelineno-188-4 name=__codelineno-188-4 href=#__codelineno-188-4></a><span class=x> <title>MyPage</title></span>
|
||
<a id=__codelineno-188-5 name=__codelineno-188-5 href=#__codelineno-188-5></a><span class=x> ...</span>
|
||
<a id=__codelineno-188-6 name=__codelineno-188-6 href=#__codelineno-188-6></a><span class=x> </span><span class=cp>{%</span> <span class=k>component_css_dependencies</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-188-7 name=__codelineno-188-7 href=#__codelineno-188-7></a><span class=x> </head></span>
|
||
<a id=__codelineno-188-8 name=__codelineno-188-8 href=#__codelineno-188-8></a><span class=x> <body></span>
|
||
<a id=__codelineno-188-9 name=__codelineno-188-9 href=#__codelineno-188-9></a><span class=x> <main></span>
|
||
<a id=__codelineno-188-10 name=__codelineno-188-10 href=#__codelineno-188-10></a><span class=x> ...</span>
|
||
<a id=__codelineno-188-11 name=__codelineno-188-11 href=#__codelineno-188-11></a><span class=x> </main></span>
|
||
<a id=__codelineno-188-12 name=__codelineno-188-12 href=#__codelineno-188-12></a><span class=x> </span><span class=cp>{%</span> <span class=k>component_js_dependencies</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-188-13 name=__codelineno-188-13 href=#__codelineno-188-13></a><span class=x> </body></span>
|
||
<a id=__codelineno-188-14 name=__codelineno-188-14 href=#__codelineno-188-14></a><span class=x></html></span>
|
||
</code></pre></div> <h3 id=setting-up-componentdependencymiddleware>Setting Up <code>ComponentDependencyMiddleware</code><a class=headerlink href=#setting-up-componentdependencymiddleware title="Permanent link">¤</a></h3> <p><code>ComponentDependencyMiddleware</code> is a Django middleware designed to manage and inject CSS/JS dependencies for rendered components dynamically. It ensures that only the necessary stylesheets and scripts are loaded in your HTML responses, based on the components used in your Django templates.</p> <p>To set it up, add the middleware to your <code>MIDDLEWARE</code> in settings.py:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-189-1 name=__codelineno-189-1 href=#__codelineno-189-1></a><span class=n>MIDDLEWARE</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-189-2 name=__codelineno-189-2 href=#__codelineno-189-2></a> <span class=c1># ... other middleware classes ...</span>
|
||
<a id=__codelineno-189-3 name=__codelineno-189-3 href=#__codelineno-189-3></a> <span class=s1>'django_components.middleware.ComponentDependencyMiddleware'</span>
|
||
<a id=__codelineno-189-4 name=__codelineno-189-4 href=#__codelineno-189-4></a> <span class=c1># ... other middleware classes ...</span>
|
||
<a id=__codelineno-189-5 name=__codelineno-189-5 href=#__codelineno-189-5></a><span class=p>]</span>
|
||
</code></pre></div> <h3 id=render_dependencies-and-deep-dive-into-rendering-js-css-without-the-middleware><code>render_dependencies</code> and deep-dive into rendering JS / CSS without the middleware<a class=headerlink href=#render_dependencies-and-deep-dive-into-rendering-js-css-without-the-middleware title="Permanent link">¤</a></h3> <p>For most scenarios, using the <code>ComponentDependencyMiddleware</code> middleware will be just fine.</p> <p>However, this section is for you if you want to: - Render HTML that will NOT be sent as a server response - Insert pre-rendered HTML into another component - Render HTML fragments (partials)</p> <p>Every time there is an HTML string that has parts which were rendered using components, and any of those components has JS / CSS, then this HTML string MUST be processed with <code>render_dependencies</code>.</p> <p>It is actually <code>render_dependencies</code> that finds all used components in the HTML string, and inserts the component's JS and CSS into <code>{% component_dependencies %}</code> tags, or at the default locations.</p> <h4 id=render-js-css-without-the-middleware>Render JS / CSS without the middleware<a class=headerlink href=#render-js-css-without-the-middleware title="Permanent link">¤</a></h4> <p>The <code>ComponentDependencyMiddleware</code> middleware just calls <code>render_dependencies</code>, passing in the HTML content. So if you rendered a template that contained <code>{% components %}</code> tags, instead of the middleware, you MUST pass the result through <code>render_dependencies</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-190-1 name=__codelineno-190-1 href=#__codelineno-190-1></a><span class=kn>from</span> <span class=nn>django.template.base</span> <span class=kn>import</span> <span class=n>Template</span>
|
||
<a id=__codelineno-190-2 name=__codelineno-190-2 href=#__codelineno-190-2></a><span class=kn>from</span> <span class=nn>django.template.context</span> <span class=kn>import</span> <span class=n>Context</span>
|
||
<a id=__codelineno-190-3 name=__codelineno-190-3 href=#__codelineno-190-3></a><span class=kn>from</span> <span class=nn>django_component</span> <span class=kn>import</span> <span class=n>render_dependencies</span>
|
||
<a id=__codelineno-190-4 name=__codelineno-190-4 href=#__codelineno-190-4></a>
|
||
<a id=__codelineno-190-5 name=__codelineno-190-5 href=#__codelineno-190-5></a><span class=n>template</span> <span class=o>=</span> <span class=n>Template</span><span class=p>(</span><span class=s2>"""</span>
|
||
<a id=__codelineno-190-6 name=__codelineno-190-6 href=#__codelineno-190-6></a><span class=s2> {</span><span class=si>% lo</span><span class=s2>ad component_tags %}</span>
|
||
<a id=__codelineno-190-7 name=__codelineno-190-7 href=#__codelineno-190-7></a><span class=s2> <!doctype html></span>
|
||
<a id=__codelineno-190-8 name=__codelineno-190-8 href=#__codelineno-190-8></a><span class=s2> <html></span>
|
||
<a id=__codelineno-190-9 name=__codelineno-190-9 href=#__codelineno-190-9></a><span class=s2> <head></span>
|
||
<a id=__codelineno-190-10 name=__codelineno-190-10 href=#__codelineno-190-10></a><span class=s2> <title>MyPage</title></span>
|
||
<a id=__codelineno-190-11 name=__codelineno-190-11 href=#__codelineno-190-11></a><span class=s2> </head></span>
|
||
<a id=__codelineno-190-12 name=__codelineno-190-12 href=#__codelineno-190-12></a><span class=s2> <body></span>
|
||
<a id=__codelineno-190-13 name=__codelineno-190-13 href=#__codelineno-190-13></a><span class=s2> <main></span>
|
||
<a id=__codelineno-190-14 name=__codelineno-190-14 href=#__codelineno-190-14></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent "my_button" %}</span>
|
||
<a id=__codelineno-190-15 name=__codelineno-190-15 href=#__codelineno-190-15></a><span class=s2> Click me!</span>
|
||
<a id=__codelineno-190-16 name=__codelineno-190-16 href=#__codelineno-190-16></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndcomponent %}</span>
|
||
<a id=__codelineno-190-17 name=__codelineno-190-17 href=#__codelineno-190-17></a><span class=s2> </main></span>
|
||
<a id=__codelineno-190-18 name=__codelineno-190-18 href=#__codelineno-190-18></a><span class=s2> </body></span>
|
||
<a id=__codelineno-190-19 name=__codelineno-190-19 href=#__codelineno-190-19></a><span class=s2> </html></span>
|
||
<a id=__codelineno-190-20 name=__codelineno-190-20 href=#__codelineno-190-20></a><span class=s2>"""</span><span class=p>)</span>
|
||
<a id=__codelineno-190-21 name=__codelineno-190-21 href=#__codelineno-190-21></a>
|
||
<a id=__codelineno-190-22 name=__codelineno-190-22 href=#__codelineno-190-22></a><span class=n>rendered</span> <span class=o>=</span> <span class=n>template</span><span class=o>.</span><span class=n>render</span><span class=p>(</span><span class=n>Context</span><span class=p>({}))</span>
|
||
<a id=__codelineno-190-23 name=__codelineno-190-23 href=#__codelineno-190-23></a><span class=n>rendered</span> <span class=o>=</span> <span class=n>render_dependencies</span><span class=p>(</span><span class=n>rendered</span><span class=p>)</span>
|
||
</code></pre></div> <p>Same applies if you render a template using Django's <a href=https://docs.djangoproject.com/en/5.1/topics/http/shortcuts/#render><code>django.shortcuts.render</code></a>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-191-1 name=__codelineno-191-1 href=#__codelineno-191-1></a><span class=kn>from</span> <span class=nn>django.shortcuts</span> <span class=kn>import</span> <span class=n>render</span>
|
||
<a id=__codelineno-191-2 name=__codelineno-191-2 href=#__codelineno-191-2></a>
|
||
<a id=__codelineno-191-3 name=__codelineno-191-3 href=#__codelineno-191-3></a><span class=k>def</span> <span class=nf>my_view</span><span class=p>(</span><span class=n>request</span><span class=p>):</span>
|
||
<a id=__codelineno-191-4 name=__codelineno-191-4 href=#__codelineno-191-4></a> <span class=n>rendered</span> <span class=o>=</span> <span class=n>render</span><span class=p>(</span><span class=n>request</span><span class=p>,</span> <span class=s2>"pages/home.html"</span><span class=p>)</span>
|
||
<a id=__codelineno-191-5 name=__codelineno-191-5 href=#__codelineno-191-5></a> <span class=n>rendered</span> <span class=o>=</span> <span class=n>render_dependencies</span><span class=p>(</span><span class=n>rendered</span><span class=p>)</span>
|
||
<a id=__codelineno-191-6 name=__codelineno-191-6 href=#__codelineno-191-6></a> <span class=k>return</span> <span class=n>rendered</span>
|
||
</code></pre></div> <p>Alternatively, when you render HTML with <code>Component.render()</code> or <code>Component.render_to_response()</code>, these automatically call <code>render_dependencies()</code> for you, so you don't have to:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-192-1 name=__codelineno-192-1 href=#__codelineno-192-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span>
|
||
<a id=__codelineno-192-2 name=__codelineno-192-2 href=#__codelineno-192-2></a>
|
||
<a id=__codelineno-192-3 name=__codelineno-192-3 href=#__codelineno-192-3></a><span class=k>class</span> <span class=nc>MyButton</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-192-4 name=__codelineno-192-4 href=#__codelineno-192-4></a> <span class=o>...</span>
|
||
<a id=__codelineno-192-5 name=__codelineno-192-5 href=#__codelineno-192-5></a>
|
||
<a id=__codelineno-192-6 name=__codelineno-192-6 href=#__codelineno-192-6></a><span class=c1># No need to call `render_dependencies()`</span>
|
||
<a id=__codelineno-192-7 name=__codelineno-192-7 href=#__codelineno-192-7></a><span class=n>rendered</span> <span class=o>=</span> <span class=n>MyButton</span><span class=o>.</span><span class=n>render</span><span class=p>()</span>
|
||
</code></pre></div> <h4 id=inserting-pre-rendered-html-into-another-component>Inserting pre-rendered HTML into another component<a class=headerlink href=#inserting-pre-rendered-html-into-another-component title="Permanent link">¤</a></h4> <p>In previous section we've shown that <code>render_dependencies()</code> does NOT need to be called when you render a component via <code>Component.render()</code>.</p> <p>API of django-components makes it possible to compose components in a "React-like" way, where we pre-render a piece of HTML and then insert it into a larger structure.</p> <p>To do this, you must add <code>render_dependencies=False</code> to the nested components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-193-1 name=__codelineno-193-1 href=#__codelineno-193-1></a><span class=n>card_actions</span> <span class=o>=</span> <span class=n>CardActions</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-193-2 name=__codelineno-193-2 href=#__codelineno-193-2></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span><span class=s2>"editable"</span><span class=p>:</span> <span class=n>editable</span><span class=p>},</span>
|
||
<a id=__codelineno-193-3 name=__codelineno-193-3 href=#__codelineno-193-3></a> <span class=n>render_dependencies</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-193-4 name=__codelineno-193-4 href=#__codelineno-193-4></a><span class=p>)</span>
|
||
<a id=__codelineno-193-5 name=__codelineno-193-5 href=#__codelineno-193-5></a>
|
||
<a id=__codelineno-193-6 name=__codelineno-193-6 href=#__codelineno-193-6></a><span class=n>card</span> <span class=o>=</span> <span class=n>Card</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-193-7 name=__codelineno-193-7 href=#__codelineno-193-7></a> <span class=n>slots</span><span class=o>=</span><span class=p>{</span><span class=s2>"actions"</span><span class=p>:</span> <span class=n>card_actions</span><span class=p>},</span>
|
||
<a id=__codelineno-193-8 name=__codelineno-193-8 href=#__codelineno-193-8></a> <span class=n>render_dependencies</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-193-9 name=__codelineno-193-9 href=#__codelineno-193-9></a><span class=p>)</span>
|
||
<a id=__codelineno-193-10 name=__codelineno-193-10 href=#__codelineno-193-10></a>
|
||
<a id=__codelineno-193-11 name=__codelineno-193-11 href=#__codelineno-193-11></a><span class=n>page</span> <span class=o>=</span> <span class=n>MyPage</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
||
<a id=__codelineno-193-12 name=__codelineno-193-12 href=#__codelineno-193-12></a> <span class=n>slots</span><span class=o>=</span><span class=p>{</span><span class=s2>"card"</span><span class=p>:</span> <span class=n>card</span><span class=p>},</span>
|
||
<a id=__codelineno-193-13 name=__codelineno-193-13 href=#__codelineno-193-13></a><span class=p>)</span>
|
||
</code></pre></div> <p>Why is <code>render_dependencies=False</code> required?</p> <p>As mentioned earlier, each time we call <code>Component.render()</code>, we also call <code>render_dependencies()</code>.</p> <p>However, there is a problem here - When we call <code>render_dependencies()</code> inside <code>CardActions.render()</code>, we extract the info on components' JS and CSS from the HTML. But the template of <code>CardActions</code> contains no <code>{% component_depedencies %}</code> tags, and nor <code><head></code> nor <code><body></code> HTML tags. So the component's JS and CSS will NOT be inserted, and will be lost.</p> <p>To work around this, you must set <code>render_dependencies=False</code> when rendering pieces of HTML with <code>Component.render()</code> and inserting them into larger structures.</p> <h2 id=available-settings>Available settings<a class=headerlink href=#available-settings title="Permanent link">¤</a></h2> <p>All library settings are handled from a global <code>COMPONENTS</code> variable that is read from <code>settings.py</code>. By default you don't need it set, there are resonable defaults.</p> <p>Here's overview of all available settings and their defaults:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-194-1 name=__codelineno-194-1 href=#__codelineno-194-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-194-2 name=__codelineno-194-2 href=#__codelineno-194-2></a> <span class=s2>"autodiscover"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
||
<a id=__codelineno-194-3 name=__codelineno-194-3 href=#__codelineno-194-3></a> <span class=s2>"context_behavior"</span><span class=p>:</span> <span class=s2>"django"</span><span class=p>,</span> <span class=c1># "django" | "isolated"</span>
|
||
<a id=__codelineno-194-4 name=__codelineno-194-4 href=#__codelineno-194-4></a> <span class=s2>"dirs"</span><span class=p>:</span> <span class=p>[</span><span class=n>BASE_DIR</span> <span class=o>/</span> <span class=s2>"components"</span><span class=p>],</span> <span class=c1># Root-level "components" dirs, e.g. `/path/to/proj/components/`</span>
|
||
<a id=__codelineno-194-5 name=__codelineno-194-5 href=#__codelineno-194-5></a> <span class=s2>"app_dirs"</span><span class=p>:</span> <span class=p>[</span><span class=s2>"components"</span><span class=p>],</span> <span class=c1># App-level "components" dirs, e.g. `[app]/components/`</span>
|
||
<a id=__codelineno-194-6 name=__codelineno-194-6 href=#__codelineno-194-6></a> <span class=s2>"dynamic_component_name"</span><span class=p>:</span> <span class=s2>"dynamic"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-7 name=__codelineno-194-7 href=#__codelineno-194-7></a> <span class=s2>"libraries"</span><span class=p>:</span> <span class=p>[],</span> <span class=c1># ["mysite.components.forms", ...]</span>
|
||
<a id=__codelineno-194-8 name=__codelineno-194-8 href=#__codelineno-194-8></a> <span class=s2>"multiline_tags"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
||
<a id=__codelineno-194-9 name=__codelineno-194-9 href=#__codelineno-194-9></a> <span class=s2>"reload_on_template_change"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-194-10 name=__codelineno-194-10 href=#__codelineno-194-10></a> <span class=s2>"static_files_allowed"</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-194-11 name=__codelineno-194-11 href=#__codelineno-194-11></a> <span class=s2>".css"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-12 name=__codelineno-194-12 href=#__codelineno-194-12></a> <span class=s2>".js"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-13 name=__codelineno-194-13 href=#__codelineno-194-13></a> <span class=c1># Images</span>
|
||
<a id=__codelineno-194-14 name=__codelineno-194-14 href=#__codelineno-194-14></a> <span class=s2>".apng"</span><span class=p>,</span> <span class=s2>".png"</span><span class=p>,</span> <span class=s2>".avif"</span><span class=p>,</span> <span class=s2>".gif"</span><span class=p>,</span> <span class=s2>".jpg"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-15 name=__codelineno-194-15 href=#__codelineno-194-15></a> <span class=s2>".jpeg"</span><span class=p>,</span> <span class=s2>".jfif"</span><span class=p>,</span> <span class=s2>".pjpeg"</span><span class=p>,</span> <span class=s2>".pjp"</span><span class=p>,</span> <span class=s2>".svg"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-16 name=__codelineno-194-16 href=#__codelineno-194-16></a> <span class=s2>".webp"</span><span class=p>,</span> <span class=s2>".bmp"</span><span class=p>,</span> <span class=s2>".ico"</span><span class=p>,</span> <span class=s2>".cur"</span><span class=p>,</span> <span class=s2>".tif"</span><span class=p>,</span> <span class=s2>".tiff"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-17 name=__codelineno-194-17 href=#__codelineno-194-17></a> <span class=c1># Fonts</span>
|
||
<a id=__codelineno-194-18 name=__codelineno-194-18 href=#__codelineno-194-18></a> <span class=s2>".eot"</span><span class=p>,</span> <span class=s2>".ttf"</span><span class=p>,</span> <span class=s2>".woff"</span><span class=p>,</span> <span class=s2>".otf"</span><span class=p>,</span> <span class=s2>".svg"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-19 name=__codelineno-194-19 href=#__codelineno-194-19></a> <span class=p>],</span>
|
||
<a id=__codelineno-194-20 name=__codelineno-194-20 href=#__codelineno-194-20></a> <span class=s2>"static_files_forbidden"</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-194-21 name=__codelineno-194-21 href=#__codelineno-194-21></a> <span class=s2>".html"</span><span class=p>,</span> <span class=s2>".django"</span><span class=p>,</span> <span class=s2>".dj"</span><span class=p>,</span> <span class=s2>".tpl"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-22 name=__codelineno-194-22 href=#__codelineno-194-22></a> <span class=c1># Python files</span>
|
||
<a id=__codelineno-194-23 name=__codelineno-194-23 href=#__codelineno-194-23></a> <span class=s2>".py"</span><span class=p>,</span> <span class=s2>".pyc"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-24 name=__codelineno-194-24 href=#__codelineno-194-24></a> <span class=p>],</span>
|
||
<a id=__codelineno-194-25 name=__codelineno-194-25 href=#__codelineno-194-25></a> <span class=s2>"tag_formatter"</span><span class=p>:</span> <span class=s2>"django_components.component_formatter"</span><span class=p>,</span>
|
||
<a id=__codelineno-194-26 name=__codelineno-194-26 href=#__codelineno-194-26></a> <span class=s2>"template_cache_size"</span><span class=p>:</span> <span class=mi>128</span><span class=p>,</span>
|
||
<a id=__codelineno-194-27 name=__codelineno-194-27 href=#__codelineno-194-27></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=libraries-load-component-modules><code>libraries</code> - Load component modules<a class=headerlink href=#libraries-load-component-modules title="Permanent link">¤</a></h3> <p>Configure the locations where components are loaded. To do this, add a <code>COMPONENTS</code> variable to you <code>settings.py</code> with a list of python paths to load. This allows you to build a structure of components that are independent from your apps.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-195-1 name=__codelineno-195-1 href=#__codelineno-195-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-195-2 name=__codelineno-195-2 href=#__codelineno-195-2></a> <span class=s2>"libraries"</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-195-3 name=__codelineno-195-3 href=#__codelineno-195-3></a> <span class=s2>"mysite.components.forms"</span><span class=p>,</span>
|
||
<a id=__codelineno-195-4 name=__codelineno-195-4 href=#__codelineno-195-4></a> <span class=s2>"mysite.components.buttons"</span><span class=p>,</span>
|
||
<a id=__codelineno-195-5 name=__codelineno-195-5 href=#__codelineno-195-5></a> <span class=s2>"mysite.components.cards"</span><span class=p>,</span>
|
||
<a id=__codelineno-195-6 name=__codelineno-195-6 href=#__codelineno-195-6></a> <span class=p>],</span>
|
||
<a id=__codelineno-195-7 name=__codelineno-195-7 href=#__codelineno-195-7></a><span class=p>}</span>
|
||
</code></pre></div> <p>Where <code>mysite/components/forms.py</code> may look like this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-196-1 name=__codelineno-196-1 href=#__codelineno-196-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"form_simple"</span><span class=p>)</span>
|
||
<a id=__codelineno-196-2 name=__codelineno-196-2 href=#__codelineno-196-2></a><span class=k>class</span> <span class=nc>FormSimple</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-196-3 name=__codelineno-196-3 href=#__codelineno-196-3></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-196-4 name=__codelineno-196-4 href=#__codelineno-196-4></a><span class=s2> <form></span>
|
||
<a id=__codelineno-196-5 name=__codelineno-196-5 href=#__codelineno-196-5></a><span class=s2> ...</span>
|
||
<a id=__codelineno-196-6 name=__codelineno-196-6 href=#__codelineno-196-6></a><span class=s2> </form></span>
|
||
<a id=__codelineno-196-7 name=__codelineno-196-7 href=#__codelineno-196-7></a><span class=s2> """</span>
|
||
<a id=__codelineno-196-8 name=__codelineno-196-8 href=#__codelineno-196-8></a>
|
||
<a id=__codelineno-196-9 name=__codelineno-196-9 href=#__codelineno-196-9></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"form_other"</span><span class=p>)</span>
|
||
<a id=__codelineno-196-10 name=__codelineno-196-10 href=#__codelineno-196-10></a><span class=k>class</span> <span class=nc>FormOther</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-196-11 name=__codelineno-196-11 href=#__codelineno-196-11></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-196-12 name=__codelineno-196-12 href=#__codelineno-196-12></a><span class=s2> <form></span>
|
||
<a id=__codelineno-196-13 name=__codelineno-196-13 href=#__codelineno-196-13></a><span class=s2> ...</span>
|
||
<a id=__codelineno-196-14 name=__codelineno-196-14 href=#__codelineno-196-14></a><span class=s2> </form></span>
|
||
<a id=__codelineno-196-15 name=__codelineno-196-15 href=#__codelineno-196-15></a><span class=s2> """</span>
|
||
</code></pre></div> <p>In the rare cases when you need to manually trigger the import of libraries, you can use the <code>import_libraries</code> function:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-197-1 name=__codelineno-197-1 href=#__codelineno-197-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>import_libraries</span>
|
||
<a id=__codelineno-197-2 name=__codelineno-197-2 href=#__codelineno-197-2></a>
|
||
<a id=__codelineno-197-3 name=__codelineno-197-3 href=#__codelineno-197-3></a><span class=n>import_libraries</span><span class=p>()</span>
|
||
</code></pre></div> <h3 id=autodiscover-toggle-autodiscovery><code>autodiscover</code> - Toggle autodiscovery<a class=headerlink href=#autodiscover-toggle-autodiscovery title="Permanent link">¤</a></h3> <p>If you specify all the component locations with the setting above and have a lot of apps, you can (very) slightly speed things up by disabling autodiscovery.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-198-1 name=__codelineno-198-1 href=#__codelineno-198-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-198-2 name=__codelineno-198-2 href=#__codelineno-198-2></a> <span class=s2>"autodiscover"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-198-3 name=__codelineno-198-3 href=#__codelineno-198-3></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=dirs><code>dirs</code><a class=headerlink href=#dirs title="Permanent link">¤</a></h3> <p>Specify the directories that contain your components.</p> <p>Directories must be full paths, same as with STATICFILES_DIRS.</p> <p>These locations are searched during autodiscovery, or when you define HTML, JS, or CSS as a separate file.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-199-1 name=__codelineno-199-1 href=#__codelineno-199-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-199-2 name=__codelineno-199-2 href=#__codelineno-199-2></a> <span class=s2>"dirs"</span><span class=p>:</span> <span class=p>[</span><span class=n>BASE_DIR</span> <span class=o>/</span> <span class=s2>"components"</span><span class=p>],</span>
|
||
<a id=__codelineno-199-3 name=__codelineno-199-3 href=#__codelineno-199-3></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=app_dirs><code>app_dirs</code><a class=headerlink href=#app_dirs title="Permanent link">¤</a></h3> <p>Specify the app-level directories that contain your components.</p> <p>Directories must be relative to app, e.g.:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-200-1 name=__codelineno-200-1 href=#__codelineno-200-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-200-2 name=__codelineno-200-2 href=#__codelineno-200-2></a> <span class=s2>"app_dirs"</span><span class=p>:</span> <span class=p>[</span><span class=s2>"my_comps"</span><span class=p>],</span> <span class=c1># To search for [app]/my_comps</span>
|
||
<a id=__codelineno-200-3 name=__codelineno-200-3 href=#__codelineno-200-3></a><span class=p>}</span>
|
||
</code></pre></div> <p>These locations are searched during autodiscovery, or when you define HTML, JS, or CSS as a separate file.</p> <p>Each app will be searched for these directories.</p> <p>Set to empty list to disable app-level components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-201-1 name=__codelineno-201-1 href=#__codelineno-201-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-201-2 name=__codelineno-201-2 href=#__codelineno-201-2></a> <span class=s2>"app_dirs"</span><span class=p>:</span> <span class=p>[],</span>
|
||
<a id=__codelineno-201-3 name=__codelineno-201-3 href=#__codelineno-201-3></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=dynamic_component_name><code>dynamic_component_name</code><a class=headerlink href=#dynamic_component_name title="Permanent link">¤</a></h3> <p>By default, the dynamic component is registered under the name <code>"dynamic"</code>. In case of a conflict, use this setting to change the name used for the dynamic components.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-202-1 name=__codelineno-202-1 href=#__codelineno-202-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-202-2 name=__codelineno-202-2 href=#__codelineno-202-2></a> <span class=s2>"dynamic_component_name"</span><span class=p>:</span> <span class=s2>"new_dynamic"</span><span class=p>,</span>
|
||
<a id=__codelineno-202-3 name=__codelineno-202-3 href=#__codelineno-202-3></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=multiline_tags-enabledisable-multiline-support><code>multiline_tags</code> - Enable/Disable multiline support<a class=headerlink href=#multiline_tags-enabledisable-multiline-support title="Permanent link">¤</a></h3> <p>If <code>True</code>, template tags can span multiple lines. Default: <code>True</code></p> <div class=highlight><pre><span></span><code><a id=__codelineno-203-1 name=__codelineno-203-1 href=#__codelineno-203-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-203-2 name=__codelineno-203-2 href=#__codelineno-203-2></a> <span class=s2>"multiline_tags"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
||
<a id=__codelineno-203-3 name=__codelineno-203-3 href=#__codelineno-203-3></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=static_files_allowed><code>static_files_allowed</code><a class=headerlink href=#static_files_allowed title="Permanent link">¤</a></h3> <p>A list of regex patterns (as strings) that define which files within <code>COMPONENTS.dirs</code> and <code>COMPONENTS.app_dirs</code> are treated as static files.</p> <p>If a file is matched against any of the patterns, it's considered a static file. Such files are collected when running <code>collectstatic</code>, and can be accessed under the static file endpoint.</p> <p>You can also pass in compiled regexes (<code>re.Pattern</code>) for more advanced patterns.</p> <p>By default, JS, CSS, and common image and font file formats are considered static files:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-204-1 name=__codelineno-204-1 href=#__codelineno-204-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-204-2 name=__codelineno-204-2 href=#__codelineno-204-2></a> <span class=s2>"static_files_allowed"</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-204-3 name=__codelineno-204-3 href=#__codelineno-204-3></a> <span class=s2>"css"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-4 name=__codelineno-204-4 href=#__codelineno-204-4></a> <span class=s2>"js"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-5 name=__codelineno-204-5 href=#__codelineno-204-5></a> <span class=c1># Images</span>
|
||
<a id=__codelineno-204-6 name=__codelineno-204-6 href=#__codelineno-204-6></a> <span class=s2>".apng"</span><span class=p>,</span> <span class=s2>".png"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-7 name=__codelineno-204-7 href=#__codelineno-204-7></a> <span class=s2>".avif"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-8 name=__codelineno-204-8 href=#__codelineno-204-8></a> <span class=s2>".gif"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-9 name=__codelineno-204-9 href=#__codelineno-204-9></a> <span class=s2>".jpg"</span><span class=p>,</span> <span class=s2>".jpeg"</span><span class=p>,</span> <span class=s2>".jfif"</span><span class=p>,</span> <span class=s2>".pjpeg"</span><span class=p>,</span> <span class=s2>".pjp"</span><span class=p>,</span> <span class=c1># JPEG</span>
|
||
<a id=__codelineno-204-10 name=__codelineno-204-10 href=#__codelineno-204-10></a> <span class=s2>".svg"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-11 name=__codelineno-204-11 href=#__codelineno-204-11></a> <span class=s2>".webp"</span><span class=p>,</span> <span class=s2>".bmp"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-12 name=__codelineno-204-12 href=#__codelineno-204-12></a> <span class=s2>".ico"</span><span class=p>,</span> <span class=s2>".cur"</span><span class=p>,</span> <span class=c1># ICO</span>
|
||
<a id=__codelineno-204-13 name=__codelineno-204-13 href=#__codelineno-204-13></a> <span class=s2>".tif"</span><span class=p>,</span> <span class=s2>".tiff"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-14 name=__codelineno-204-14 href=#__codelineno-204-14></a> <span class=c1># Fonts</span>
|
||
<a id=__codelineno-204-15 name=__codelineno-204-15 href=#__codelineno-204-15></a> <span class=s2>".eot"</span><span class=p>,</span> <span class=s2>".ttf"</span><span class=p>,</span> <span class=s2>".woff"</span><span class=p>,</span> <span class=s2>".otf"</span><span class=p>,</span> <span class=s2>".svg"</span><span class=p>,</span>
|
||
<a id=__codelineno-204-16 name=__codelineno-204-16 href=#__codelineno-204-16></a> <span class=p>],</span>
|
||
<a id=__codelineno-204-17 name=__codelineno-204-17 href=#__codelineno-204-17></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=static_files_forbidden><code>static_files_forbidden</code><a class=headerlink href=#static_files_forbidden title="Permanent link">¤</a></h3> <p>A list of suffixes that define which files within <code>COMPONENTS.dirs</code> and <code>COMPONENTS.app_dirs</code> will NEVER be treated as static files.</p> <p>If a file is matched against any of the patterns, it will never be considered a static file, even if the file matches a pattern in <a href=#static_files_allowed><code>COMPONENTS.static_files_allowed</code></a>.</p> <p>Use this setting together with <code>COMPONENTS.static_files_allowed</code> for a fine control over what files will be exposed.</p> <p>You can also pass in compiled regexes (<code>re.Pattern</code>) for more advanced patterns.</p> <p>By default, any HTML and Python are considered NOT static files:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-205-1 name=__codelineno-205-1 href=#__codelineno-205-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-205-2 name=__codelineno-205-2 href=#__codelineno-205-2></a> <span class=s2>"static_files_forbidden"</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-205-3 name=__codelineno-205-3 href=#__codelineno-205-3></a> <span class=s2>".html"</span><span class=p>,</span> <span class=s2>".django"</span><span class=p>,</span> <span class=s2>".dj"</span><span class=p>,</span> <span class=s2>".tpl"</span><span class=p>,</span> <span class=s2>".py"</span><span class=p>,</span> <span class=s2>".pyc"</span><span class=p>,</span>
|
||
<a id=__codelineno-205-4 name=__codelineno-205-4 href=#__codelineno-205-4></a> <span class=p>],</span>
|
||
<a id=__codelineno-205-5 name=__codelineno-205-5 href=#__codelineno-205-5></a><span class=p>}</span>
|
||
</code></pre></div> <h3 id=template_cache_size-tune-the-template-cache><code>template_cache_size</code> - Tune the template cache<a class=headerlink href=#template_cache_size-tune-the-template-cache title="Permanent link">¤</a></h3> <p>Each time a template is rendered it is cached to a global in-memory cache (using Python's <code>lru_cache</code> decorator). This speeds up the next render of the component. As the same component is often used many times on the same page, these savings add up.</p> <p>By default the cache holds 128 component templates in memory, which should be enough for most sites. But if you have a lot of components, or if you are using the <code>template</code> method of a component to render lots of dynamic templates, you can increase this number. To remove the cache limit altogether and cache everything, set template_cache_size to <code>None</code>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-206-1 name=__codelineno-206-1 href=#__codelineno-206-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-206-2 name=__codelineno-206-2 href=#__codelineno-206-2></a> <span class=s2>"template_cache_size"</span><span class=p>:</span> <span class=mi>256</span><span class=p>,</span>
|
||
<a id=__codelineno-206-3 name=__codelineno-206-3 href=#__codelineno-206-3></a><span class=p>}</span>
|
||
</code></pre></div> <p>If you want add templates to the cache yourself, you can use <code>cached_template()</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-207-1 name=__codelineno-207-1 href=#__codelineno-207-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>cached_template</span>
|
||
<a id=__codelineno-207-2 name=__codelineno-207-2 href=#__codelineno-207-2></a>
|
||
<a id=__codelineno-207-3 name=__codelineno-207-3 href=#__codelineno-207-3></a><span class=n>cached_template</span><span class=p>(</span><span class=s2>"Variable: {{ variable }}"</span><span class=p>)</span>
|
||
<a id=__codelineno-207-4 name=__codelineno-207-4 href=#__codelineno-207-4></a>
|
||
<a id=__codelineno-207-5 name=__codelineno-207-5 href=#__codelineno-207-5></a><span class=c1># You can optionally specify Template class, and other Template inputs:</span>
|
||
<a id=__codelineno-207-6 name=__codelineno-207-6 href=#__codelineno-207-6></a><span class=k>class</span> <span class=nc>MyTemplate</span><span class=p>(</span><span class=n>Template</span><span class=p>):</span>
|
||
<a id=__codelineno-207-7 name=__codelineno-207-7 href=#__codelineno-207-7></a> <span class=k>pass</span>
|
||
<a id=__codelineno-207-8 name=__codelineno-207-8 href=#__codelineno-207-8></a>
|
||
<a id=__codelineno-207-9 name=__codelineno-207-9 href=#__codelineno-207-9></a><span class=n>cached_template</span><span class=p>(</span>
|
||
<a id=__codelineno-207-10 name=__codelineno-207-10 href=#__codelineno-207-10></a> <span class=s2>"Variable: {{ variable }}"</span><span class=p>,</span>
|
||
<a id=__codelineno-207-11 name=__codelineno-207-11 href=#__codelineno-207-11></a> <span class=n>template_cls</span><span class=o>=</span><span class=n>MyTemplate</span><span class=p>,</span>
|
||
<a id=__codelineno-207-12 name=__codelineno-207-12 href=#__codelineno-207-12></a> <span class=n>name</span><span class=o>=...</span>
|
||
<a id=__codelineno-207-13 name=__codelineno-207-13 href=#__codelineno-207-13></a> <span class=n>origin</span><span class=o>=...</span>
|
||
<a id=__codelineno-207-14 name=__codelineno-207-14 href=#__codelineno-207-14></a> <span class=n>engine</span><span class=o>=...</span>
|
||
<a id=__codelineno-207-15 name=__codelineno-207-15 href=#__codelineno-207-15></a><span class=p>)</span>
|
||
</code></pre></div> <h3 id=context_behavior-make-components-isolated-or-not><code>context_behavior</code> - Make components isolated (or not)<a class=headerlink href=#context_behavior-make-components-isolated-or-not title="Permanent link">¤</a></h3> <blockquote> <p>NOTE: <code>context_behavior</code> and <code>slot_context_behavior</code> options were merged in v0.70.</p> <p>If you are migrating from BEFORE v0.67, set <code>context_behavior</code> to <code>"django"</code>. From v0.67 to v0.78 (incl) the default value was <code>"isolated"</code>.</p> <p>For v0.79 and later, the default is again <code>"django"</code>. See the rationale for change <a href=https://github.com/EmilStenstrom/django-components/issues/498>here</a>.</p> </blockquote> <p>You can configure what variables are available inside the <code>{% fill %}</code> tags. See <a href=#component-context-and-scope>Component context and scope</a>.</p> <p>This has two modes:</p> <ul> <li><code>"django"</code> - Default - The default Django template behavior.</li> </ul> <p>Inside the <code>{% fill %}</code> tag, the context variables you can access are a union of:</p> <ul> <li>All the variables that were OUTSIDE the fill tag, including any loops or with tag</li> <li> <p>Data returned from <code>get_context_data()</code> of the component that wraps the fill tag.</p> </li> <li> <p><code>"isolated"</code> - Similar behavior to <a href=https://vuejs.org/guide/components/slots.html#render-scope>Vue</a> or React, this is useful if you want to make sure that components don't accidentally access variables defined outside of the component.</p> </li> </ul> <p>Inside the <code>{% fill %}</code> tag, you can ONLY access variables from 2 places:</p> <ul> <li><code>get_context_data()</code> of the component which defined the template (AKA the "root" component)</li> <li>Any loops (<code>{% for ... %}</code>) that the <code>{% fill %}</code> tag is part of.</li> </ul> <div class=highlight><pre><span></span><code><a id=__codelineno-208-1 name=__codelineno-208-1 href=#__codelineno-208-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-208-2 name=__codelineno-208-2 href=#__codelineno-208-2></a> <span class=s2>"context_behavior"</span><span class=p>:</span> <span class=s2>"isolated"</span><span class=p>,</span>
|
||
<a id=__codelineno-208-3 name=__codelineno-208-3 href=#__codelineno-208-3></a><span class=p>}</span>
|
||
</code></pre></div> <h4 id=example-django>Example "django"<a class=headerlink href=#example-django title="Permanent link">¤</a></h4> <p>Given this template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-209-1 name=__codelineno-209-1 href=#__codelineno-209-1></a><span class=k>class</span> <span class=nc>RootComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-209-2 name=__codelineno-209-2 href=#__codelineno-209-2></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-209-3 name=__codelineno-209-3 href=#__codelineno-209-3></a><span class=s2> {% with cheese="feta" %}</span>
|
||
<a id=__codelineno-209-4 name=__codelineno-209-4 href=#__codelineno-209-4></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent 'my_comp' %}</span>
|
||
<a id=__codelineno-209-5 name=__codelineno-209-5 href=#__codelineno-209-5></a><span class=s2> {{ my_var }} # my_var</span>
|
||
<a id=__codelineno-209-6 name=__codelineno-209-6 href=#__codelineno-209-6></a><span class=s2> {{ cheese }} # cheese</span>
|
||
<a id=__codelineno-209-7 name=__codelineno-209-7 href=#__codelineno-209-7></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndcomponent %}</span>
|
||
<a id=__codelineno-209-8 name=__codelineno-209-8 href=#__codelineno-209-8></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndwith %}</span>
|
||
<a id=__codelineno-209-9 name=__codelineno-209-9 href=#__codelineno-209-9></a><span class=s2> """</span>
|
||
<a id=__codelineno-209-10 name=__codelineno-209-10 href=#__codelineno-209-10></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-209-11 name=__codelineno-209-11 href=#__codelineno-209-11></a> <span class=k>return</span> <span class=p>{</span> <span class=s2>"my_var"</span><span class=p>:</span> <span class=mi>123</span> <span class=p>}</span>
|
||
</code></pre></div> <p>Then if <code>get_context_data()</code> of the component <code>"my_comp"</code> returns following data:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-210-1 name=__codelineno-210-1 href=#__codelineno-210-1></a><span class=p>{</span> <span class=s2>"my_var"</span><span class=p>:</span> <span class=mi>456</span> <span class=p>}</span>
|
||
</code></pre></div> <p>Then the template will be rendered as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-211-1 name=__codelineno-211-1 href=#__codelineno-211-1></a><span class=x>456 # my_var</span>
|
||
<a id=__codelineno-211-2 name=__codelineno-211-2 href=#__codelineno-211-2></a><span class=x>feta # cheese</span>
|
||
</code></pre></div> <p>Because <code>"my_comp"</code> overshadows the variable <code>"my_var"</code>, so <code>{{ my_var }}</code> equals <code>456</code>.</p> <p>And variable <code>"cheese"</code> equals <code>feta</code>, because the fill CAN access all the data defined in the outer layers, like the <code>{% with %}</code> tag.</p> <h4 id=example-isolated>Example "isolated"<a class=headerlink href=#example-isolated title="Permanent link">¤</a></h4> <p>Given this template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-212-1 name=__codelineno-212-1 href=#__codelineno-212-1></a><span class=k>class</span> <span class=nc>RootComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
||
<a id=__codelineno-212-2 name=__codelineno-212-2 href=#__codelineno-212-2></a> <span class=n>template</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-212-3 name=__codelineno-212-3 href=#__codelineno-212-3></a><span class=s2> {% with cheese="feta" %}</span>
|
||
<a id=__codelineno-212-4 name=__codelineno-212-4 href=#__codelineno-212-4></a><span class=s2> {</span><span class=si>% c</span><span class=s2>omponent 'my_comp' %}</span>
|
||
<a id=__codelineno-212-5 name=__codelineno-212-5 href=#__codelineno-212-5></a><span class=s2> {{ my_var }} # my_var</span>
|
||
<a id=__codelineno-212-6 name=__codelineno-212-6 href=#__codelineno-212-6></a><span class=s2> {{ cheese }} # cheese</span>
|
||
<a id=__codelineno-212-7 name=__codelineno-212-7 href=#__codelineno-212-7></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndcomponent %}</span>
|
||
<a id=__codelineno-212-8 name=__codelineno-212-8 href=#__codelineno-212-8></a><span class=s2> {</span><span class=si>% e</span><span class=s2>ndwith %}</span>
|
||
<a id=__codelineno-212-9 name=__codelineno-212-9 href=#__codelineno-212-9></a><span class=s2> """</span>
|
||
<a id=__codelineno-212-10 name=__codelineno-212-10 href=#__codelineno-212-10></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
|
||
<a id=__codelineno-212-11 name=__codelineno-212-11 href=#__codelineno-212-11></a> <span class=k>return</span> <span class=p>{</span> <span class=s2>"my_var"</span><span class=p>:</span> <span class=mi>123</span> <span class=p>}</span>
|
||
</code></pre></div> <p>Then if <code>get_context_data()</code> of the component <code>"my_comp"</code> returns following data:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-213-1 name=__codelineno-213-1 href=#__codelineno-213-1></a><span class=p>{</span> <span class=s2>"my_var"</span><span class=p>:</span> <span class=mi>456</span> <span class=p>}</span>
|
||
</code></pre></div> <p>Then the template will be rendered as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-214-1 name=__codelineno-214-1 href=#__codelineno-214-1></a><span class=x>123 # my_var</span>
|
||
<a id=__codelineno-214-2 name=__codelineno-214-2 href=#__codelineno-214-2></a><span class=x> # cheese</span>
|
||
</code></pre></div> <p>Because variables <code>"my_var"</code> and <code>"cheese"</code> are searched only inside <code>RootComponent.get_context_data()</code>. But since <code>"cheese"</code> is not defined there, it's empty.</p> <p>Notice that the variables defined with the <code>{% with %}</code> tag are ignored inside the <code>{% fill %}</code> tag with the <code>"isolated"</code> mode.</p> <h3 id=reload_on_template_change-reload-dev-server-on-component-file-changes><code>reload_on_template_change</code> - Reload dev server on component file changes<a class=headerlink href=#reload_on_template_change-reload-dev-server-on-component-file-changes title="Permanent link">¤</a></h3> <p>If <code>True</code>, configures Django to reload on component files. See <a href=#reload-dev-server-on-component-file-changes>Reload dev server on component file changes</a>.</p> <p>NOTE: This setting should be enabled only for the dev environment!</p> <h3 id=tag_formatter-change-how-components-are-used-in-templates><code>tag_formatter</code> - Change how components are used in templates<a class=headerlink href=#tag_formatter-change-how-components-are-used-in-templates title="Permanent link">¤</a></h3> <p>Sets the <a href=#available-tagformatters><code>TagFormatter</code></a> instance. See the section <a href=#customizing-component-tags-with-tagformatter>Customizing component tags with TagFormatter</a>.</p> <p>Can be set either as direct reference, or as an import string;</p> <div class=highlight><pre><span></span><code><a id=__codelineno-215-1 name=__codelineno-215-1 href=#__codelineno-215-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-215-2 name=__codelineno-215-2 href=#__codelineno-215-2></a> <span class=s2>"tag_formatter"</span><span class=p>:</span> <span class=s2>"django_components.component_formatter"</span>
|
||
<a id=__codelineno-215-3 name=__codelineno-215-3 href=#__codelineno-215-3></a><span class=p>}</span>
|
||
</code></pre></div> <p>Or</p> <div class=highlight><pre><span></span><code><a id=__codelineno-216-1 name=__codelineno-216-1 href=#__codelineno-216-1></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>component_formatter</span>
|
||
<a id=__codelineno-216-2 name=__codelineno-216-2 href=#__codelineno-216-2></a>
|
||
<a id=__codelineno-216-3 name=__codelineno-216-3 href=#__codelineno-216-3></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-216-4 name=__codelineno-216-4 href=#__codelineno-216-4></a> <span class=s2>"tag_formatter"</span><span class=p>:</span> <span class=n>component_formatter</span>
|
||
<a id=__codelineno-216-5 name=__codelineno-216-5 href=#__codelineno-216-5></a><span class=p>}</span>
|
||
</code></pre></div> <h2 id=running-with-development-server>Running with development server<a class=headerlink href=#running-with-development-server title="Permanent link">¤</a></h2> <h3 id=reload-dev-server-on-component-file-changes>Reload dev server on component file changes<a class=headerlink href=#reload-dev-server-on-component-file-changes title="Permanent link">¤</a></h3> <p>This is relevant if you are using the project structure as shown in our examples, where HTML, JS, CSS and Python are separate and nested in a directory.</p> <p>In this case you may notice that when you are running a development server, the server sometimes does not reload when you change comoponent files.</p> <p>From relevant <a href=https://stackoverflow.com/a/76722393/9788634>StackOverflow thread</a>:</p> <blockquote> <p>TL;DR is that the server won't reload if it thinks the changed file is in a templates directory, or in a nested sub directory of a templates directory. This is by design.</p> </blockquote> <p>To make the dev server reload on all component files, set <a href=#reload_on_template_change---reload-dev-server-on-component-file-changes><code>reload_on_template_change</code></a> to <code>True</code>. This configures Django to watch for component files too.</p> <p>NOTE: This setting should be enabled only for the dev environment!</p> <h2 id=logging-and-debugging>Logging and debugging<a class=headerlink href=#logging-and-debugging title="Permanent link">¤</a></h2> <p>Django components supports <a href=https://docs.djangoproject.com/en/5.0/howto/logging/#logging-how-to>logging with Django</a>. This can help with troubleshooting.</p> <p>To configure logging for Django components, set the <code>django_components</code> logger in <code>LOGGING</code> in <code>settings.py</code> (below).</p> <p>Also see the <a href=https://github.com/EmilStenstrom/django-components/blob/master/sampleproject/sampleproject/settings.py><code>settings.py</code> file in sampleproject</a> for a real-life example.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-217-1 name=__codelineno-217-1 href=#__codelineno-217-1></a><span class=kn>import</span> <span class=nn>logging</span>
|
||
<a id=__codelineno-217-2 name=__codelineno-217-2 href=#__codelineno-217-2></a><span class=kn>import</span> <span class=nn>sys</span>
|
||
<a id=__codelineno-217-3 name=__codelineno-217-3 href=#__codelineno-217-3></a>
|
||
<a id=__codelineno-217-4 name=__codelineno-217-4 href=#__codelineno-217-4></a><span class=n>LOGGING</span> <span class=o>=</span> <span class=p>{</span>
|
||
<a id=__codelineno-217-5 name=__codelineno-217-5 href=#__codelineno-217-5></a> <span class=s1>'version'</span><span class=p>:</span> <span class=mi>1</span><span class=p>,</span>
|
||
<a id=__codelineno-217-6 name=__codelineno-217-6 href=#__codelineno-217-6></a> <span class=s1>'disable_existing_loggers'</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
||
<a id=__codelineno-217-7 name=__codelineno-217-7 href=#__codelineno-217-7></a> <span class=s2>"handlers"</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-217-8 name=__codelineno-217-8 href=#__codelineno-217-8></a> <span class=s2>"console"</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-217-9 name=__codelineno-217-9 href=#__codelineno-217-9></a> <span class=s1>'class'</span><span class=p>:</span> <span class=s1>'logging.StreamHandler'</span><span class=p>,</span>
|
||
<a id=__codelineno-217-10 name=__codelineno-217-10 href=#__codelineno-217-10></a> <span class=s1>'stream'</span><span class=p>:</span> <span class=n>sys</span><span class=o>.</span><span class=n>stdout</span><span class=p>,</span>
|
||
<a id=__codelineno-217-11 name=__codelineno-217-11 href=#__codelineno-217-11></a> <span class=p>},</span>
|
||
<a id=__codelineno-217-12 name=__codelineno-217-12 href=#__codelineno-217-12></a> <span class=p>},</span>
|
||
<a id=__codelineno-217-13 name=__codelineno-217-13 href=#__codelineno-217-13></a> <span class=s2>"loggers"</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-217-14 name=__codelineno-217-14 href=#__codelineno-217-14></a> <span class=s2>"django_components"</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-217-15 name=__codelineno-217-15 href=#__codelineno-217-15></a> <span class=s2>"level"</span><span class=p>:</span> <span class=n>logging</span><span class=o>.</span><span class=n>DEBUG</span><span class=p>,</span>
|
||
<a id=__codelineno-217-16 name=__codelineno-217-16 href=#__codelineno-217-16></a> <span class=s2>"handlers"</span><span class=p>:</span> <span class=p>[</span><span class=s2>"console"</span><span class=p>],</span>
|
||
<a id=__codelineno-217-17 name=__codelineno-217-17 href=#__codelineno-217-17></a> <span class=p>},</span>
|
||
<a id=__codelineno-217-18 name=__codelineno-217-18 href=#__codelineno-217-18></a> <span class=p>},</span>
|
||
<a id=__codelineno-217-19 name=__codelineno-217-19 href=#__codelineno-217-19></a><span class=p>}</span>
|
||
</code></pre></div> <h2 id=management-command>Management Command<a class=headerlink href=#management-command title="Permanent link">¤</a></h2> <p>You can use the built-in management command <code>startcomponent</code> to create a django component. The command accepts the following arguments and options:</p> <ul> <li> <p><code>name</code>: The name of the component to create. This is a required argument.</p> </li> <li> <p><code>--path</code>: The path to the components directory. This is an optional argument. If not provided, the command will use the <code>BASE_DIR</code> setting from your Django settings.</p> </li> <li> <p><code>--js</code>: The name of the JavaScript file. This is an optional argument. The default value is <code>script.js</code>.</p> </li> <li> <p><code>--css</code>: The name of the CSS file. This is an optional argument. The default value is <code>style.css</code>.</p> </li> <li> <p><code>--template</code>: The name of the template file. This is an optional argument. The default value is <code>template.html</code>.</p> </li> <li> <p><code>--force</code>: This option allows you to overwrite existing files if they exist. This is an optional argument.</p> </li> <li> <p><code>--verbose</code>: This option allows the command to print additional information during component creation. This is an optional argument.</p> </li> <li> <p><code>--dry-run</code>: This option allows you to simulate component creation without actually creating any files. This is an optional argument. The default value is <code>False</code>.</p> </li> </ul> <h3 id=management-command-usage>Management Command Usage<a class=headerlink href=#management-command-usage title="Permanent link">¤</a></h3> <p>To use the command, run the following command in your terminal:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-218-1 name=__codelineno-218-1 href=#__codelineno-218-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span><name><span class=w> </span>--path<span class=w> </span><path><span class=w> </span>--js<span class=w> </span><js_filename><span class=w> </span>--css<span class=w> </span><css_filename><span class=w> </span>--template<span class=w> </span><template_filename><span class=w> </span>--force<span class=w> </span>--verbose<span class=w> </span>--dry-run
|
||
</code></pre></div> <p>Replace <code><name></code>, <code><path></code>, <code><js_filename></code>, <code><css_filename></code>, and <code><template_filename></code> with your desired values.</p> <h3 id=management-command-examples>Management Command Examples<a class=headerlink href=#management-command-examples title="Permanent link">¤</a></h3> <p>Here are some examples of how you can use the command:</p> <h3 id=creating-a-component-with-default-settings>Creating a Component with Default Settings<a class=headerlink href=#creating-a-component-with-default-settings title="Permanent link">¤</a></h3> <p>To create a component with the default settings, you only need to provide the name of the component:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-219-1 name=__codelineno-219-1 href=#__codelineno-219-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span>my_component
|
||
</code></pre></div> <p>This will create a new component named <code>my_component</code> in the <code>components</code> directory of your Django project. The JavaScript, CSS, and template files will be named <code>script.js</code>, <code>style.css</code>, and <code>template.html</code>, respectively.</p> <h3 id=creating-a-component-with-custom-settings>Creating a Component with Custom Settings<a class=headerlink href=#creating-a-component-with-custom-settings title="Permanent link">¤</a></h3> <p>You can also create a component with custom settings by providing additional arguments:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-220-1 name=__codelineno-220-1 href=#__codelineno-220-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span>new_component<span class=w> </span>--path<span class=w> </span>my_components<span class=w> </span>--js<span class=w> </span>my_script.js<span class=w> </span>--css<span class=w> </span>my_style.css<span class=w> </span>--template<span class=w> </span>my_template.html
|
||
</code></pre></div> <p>This will create a new component named <code>new_component</code> in the <code>my_components</code> directory. The JavaScript, CSS, and template files will be named <code>my_script.js</code>, <code>my_style.css</code>, and <code>my_template.html</code>, respectively.</p> <h3 id=overwriting-an-existing-component>Overwriting an Existing Component<a class=headerlink href=#overwriting-an-existing-component title="Permanent link">¤</a></h3> <p>If you want to overwrite an existing component, you can use the <code>--force</code> option:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-221-1 name=__codelineno-221-1 href=#__codelineno-221-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span>my_component<span class=w> </span>--force
|
||
</code></pre></div> <p>This will overwrite the existing <code>my_component</code> if it exists.</p> <h3 id=simulating-component-creation>Simulating Component Creation<a class=headerlink href=#simulating-component-creation title="Permanent link">¤</a></h3> <p>If you want to simulate the creation of a component without actually creating any files, you can use the <code>--dry-run</code> option:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-222-1 name=__codelineno-222-1 href=#__codelineno-222-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span>my_component<span class=w> </span>--dry-run
|
||
</code></pre></div> <p>This will simulate the creation of <code>my_component</code> without creating any files.</p> <h2 id=writing-and-sharing-component-libraries>Writing and sharing component libraries<a class=headerlink href=#writing-and-sharing-component-libraries title="Permanent link">¤</a></h2> <p>You can publish and share your components for others to use. Here are the steps to do so:</p> <h3 id=writing-component-libraries>Writing component libraries<a class=headerlink href=#writing-component-libraries title="Permanent link">¤</a></h3> <ol> <li> <p>Create a Django project with the following structure:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-223-1 name=__codelineno-223-1 href=#__codelineno-223-1></a>project/
|
||
<a id=__codelineno-223-2 name=__codelineno-223-2 href=#__codelineno-223-2></a> |-- myapp/
|
||
<a id=__codelineno-223-3 name=__codelineno-223-3 href=#__codelineno-223-3></a> |-- __init__.py
|
||
<a id=__codelineno-223-4 name=__codelineno-223-4 href=#__codelineno-223-4></a> |-- apps.py
|
||
<a id=__codelineno-223-5 name=__codelineno-223-5 href=#__codelineno-223-5></a> |-- templates/
|
||
<a id=__codelineno-223-6 name=__codelineno-223-6 href=#__codelineno-223-6></a> |-- table/
|
||
<a id=__codelineno-223-7 name=__codelineno-223-7 href=#__codelineno-223-7></a> |-- table.py
|
||
<a id=__codelineno-223-8 name=__codelineno-223-8 href=#__codelineno-223-8></a> |-- table.js
|
||
<a id=__codelineno-223-9 name=__codelineno-223-9 href=#__codelineno-223-9></a> |-- table.css
|
||
<a id=__codelineno-223-10 name=__codelineno-223-10 href=#__codelineno-223-10></a> |-- table.html
|
||
<a id=__codelineno-223-11 name=__codelineno-223-11 href=#__codelineno-223-11></a> |-- menu.py <--- single-file component
|
||
<a id=__codelineno-223-12 name=__codelineno-223-12 href=#__codelineno-223-12></a> |-- templatetags/
|
||
<a id=__codelineno-223-13 name=__codelineno-223-13 href=#__codelineno-223-13></a> |-- __init__.py
|
||
<a id=__codelineno-223-14 name=__codelineno-223-14 href=#__codelineno-223-14></a> |-- mytags.py
|
||
</code></pre></div> </li> <li> <p>Create custom <code>Library</code> and <code>ComponentRegistry</code> instances in <code>mytags.py</code></p> <p>This will be the entrypoint for using the components inside Django templates.</p> <p>Remember that Django requires the <code>Library</code> instance to be accessible under the <code>register</code> variable (<a href=https://docs.djangoproject.com/en/dev/howto/custom-template-tags>See Django docs</a>):</p> <div class=highlight><pre><span></span><code><a id=__codelineno-224-1 name=__codelineno-224-1 href=#__codelineno-224-1></a><span class=kn>from</span> <span class=nn>django.template</span> <span class=kn>import</span> <span class=n>Library</span>
|
||
<a id=__codelineno-224-2 name=__codelineno-224-2 href=#__codelineno-224-2></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>ComponentRegistry</span><span class=p>,</span> <span class=n>RegistrySettings</span>
|
||
<a id=__codelineno-224-3 name=__codelineno-224-3 href=#__codelineno-224-3></a>
|
||
<a id=__codelineno-224-4 name=__codelineno-224-4 href=#__codelineno-224-4></a><span class=n>register</span> <span class=o>=</span> <span class=n>library</span> <span class=o>=</span> <span class=n>django</span><span class=o>.</span><span class=n>template</span><span class=o>.</span><span class=n>Library</span><span class=p>()</span>
|
||
<a id=__codelineno-224-5 name=__codelineno-224-5 href=#__codelineno-224-5></a><span class=n>comp_registry</span> <span class=o>=</span> <span class=n>ComponentRegistry</span><span class=p>(</span>
|
||
<a id=__codelineno-224-6 name=__codelineno-224-6 href=#__codelineno-224-6></a> <span class=n>library</span><span class=o>=</span><span class=n>library</span><span class=p>,</span>
|
||
<a id=__codelineno-224-7 name=__codelineno-224-7 href=#__codelineno-224-7></a> <span class=n>settings</span><span class=o>=</span><span class=n>RegistrySettings</span><span class=p>(</span>
|
||
<a id=__codelineno-224-8 name=__codelineno-224-8 href=#__codelineno-224-8></a> <span class=n>context_behavior</span><span class=o>=</span><span class=s2>"isolated"</span><span class=p>,</span>
|
||
<a id=__codelineno-224-9 name=__codelineno-224-9 href=#__codelineno-224-9></a> <span class=n>tag_formatter</span><span class=o>=</span><span class=s2>"django_components.component_formatter"</span><span class=p>,</span>
|
||
<a id=__codelineno-224-10 name=__codelineno-224-10 href=#__codelineno-224-10></a> <span class=p>),</span>
|
||
<a id=__codelineno-224-11 name=__codelineno-224-11 href=#__codelineno-224-11></a><span class=p>)</span>
|
||
</code></pre></div> <p>As you can see above, this is also the place where we configure how our components should behave, using the <code>settings</code> argument. If omitted, default settings are used.</p> <p>For library authors, we recommend setting <code>context_behavior</code> to <code>"isolated"</code>, so that the state cannot leak into the components, and so the components' behavior is configured solely through the inputs. This means that the components will be more predictable and easier to debug.</p> <p>Next, you can decide how will others use your components by settingt the <code>tag_formatter</code> options.</p> <p>If omitted or set to <code>"django_components.component_formatter"</code>, your components will be used like this:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-225-1 name=__codelineno-225-1 href=#__codelineno-225-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"table"</span> <span class=nv>items</span><span class=o>=</span><span class=nv>items</span> <span class=nv>headers</span><span class=o>=</span><span class=nv>headers</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-225-2 name=__codelineno-225-2 href=#__codelineno-225-2></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Or you can use <code>"django_components.component_shorthand_formatter"</code> to use components like so:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-226-1 name=__codelineno-226-1 href=#__codelineno-226-1></a><span class=cp>{%</span> <span class=k>table</span> <span class=nv>items</span><span class=o>=</span><span class=nv>items</span> <span class=nv>headers</span><span class=o>=</span><span class=nv>headers</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-226-2 name=__codelineno-226-2 href=#__codelineno-226-2></a><span class=cp>{%</span> <span class=k>endtable</span> <span class=cp>%}</span>
|
||
</code></pre></div> <p>Or you can define a <a href=#tagformatter>custom TagFormatter</a>.</p> <p>Either way, these settings will be scoped only to your components. So, in the user code, there may be components side-by-side that use different formatters:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-227-1 name=__codelineno-227-1 href=#__codelineno-227-1></a><span class=cp>{%</span> <span class=k>load</span> <span class=nv>mytags</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-227-2 name=__codelineno-227-2 href=#__codelineno-227-2></a>
|
||
<a id=__codelineno-227-3 name=__codelineno-227-3 href=#__codelineno-227-3></a><span class=c>{# Component from your library "mytags", using the "shorthand" formatter #}</span>
|
||
<a id=__codelineno-227-4 name=__codelineno-227-4 href=#__codelineno-227-4></a><span class=cp>{%</span> <span class=k>table</span> <span class=nv>items</span><span class=o>=</span><span class=nv>items</span> <span class=nv>headers</span><span class=o>=</span><span class=nv>header</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-227-5 name=__codelineno-227-5 href=#__codelineno-227-5></a><span class=cp>{%</span> <span class=k>endtable</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-227-6 name=__codelineno-227-6 href=#__codelineno-227-6></a>
|
||
<a id=__codelineno-227-7 name=__codelineno-227-7 href=#__codelineno-227-7></a><span class=c>{# User-created components using the default settings #}</span>
|
||
<a id=__codelineno-227-8 name=__codelineno-227-8 href=#__codelineno-227-8></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span> <span class=nv>title</span><span class=o>=</span><span class=s2>"Abc..."</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-227-9 name=__codelineno-227-9 href=#__codelineno-227-9></a><span class=cp>{%</span> <span class=k>endcomponent</span> <span class=cp>%}</span>
|
||
</code></pre></div> </li> <li> <p>Write your components and register them with your instance of <code>ComponentRegistry</code></p> <p>There's one difference when you are writing components that are to be shared, and that's that the components must be explicitly registered with your instance of <code>ComponentRegistry</code> from the previous step.</p> <p>For better user experience, you can also define the types for the args, kwargs, slots and data.</p> <p>It's also a good idea to have a common prefix for your components, so they can be easily distinguished from users' components. In the example below, we use the prefix <code>my_</code> / <code>My</code>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-228-1 name=__codelineno-228-1 href=#__codelineno-228-1></a><span class=kn>from</span> <span class=nn>typing</span> <span class=kn>import</span> <span class=n>Dict</span><span class=p>,</span> <span class=n>NotRequired</span><span class=p>,</span> <span class=n>Optional</span><span class=p>,</span> <span class=n>Tuple</span><span class=p>,</span> <span class=n>TypedDict</span>
|
||
<a id=__codelineno-228-2 name=__codelineno-228-2 href=#__codelineno-228-2></a>
|
||
<a id=__codelineno-228-3 name=__codelineno-228-3 href=#__codelineno-228-3></a><span class=kn>from</span> <span class=nn>django_components</span> <span class=kn>import</span> <span class=n>Component</span><span class=p>,</span> <span class=n>SlotFunc</span><span class=p>,</span> <span class=n>register</span><span class=p>,</span> <span class=n>types</span>
|
||
<a id=__codelineno-228-4 name=__codelineno-228-4 href=#__codelineno-228-4></a>
|
||
<a id=__codelineno-228-5 name=__codelineno-228-5 href=#__codelineno-228-5></a><span class=kn>from</span> <span class=nn>myapp.templatetags.mytags</span> <span class=kn>import</span> <span class=n>comp_registry</span>
|
||
<a id=__codelineno-228-6 name=__codelineno-228-6 href=#__codelineno-228-6></a>
|
||
<a id=__codelineno-228-7 name=__codelineno-228-7 href=#__codelineno-228-7></a><span class=c1># Define the types</span>
|
||
<a id=__codelineno-228-8 name=__codelineno-228-8 href=#__codelineno-228-8></a><span class=k>class</span> <span class=nc>EmptyDict</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-228-9 name=__codelineno-228-9 href=#__codelineno-228-9></a> <span class=k>pass</span>
|
||
<a id=__codelineno-228-10 name=__codelineno-228-10 href=#__codelineno-228-10></a>
|
||
<a id=__codelineno-228-11 name=__codelineno-228-11 href=#__codelineno-228-11></a><span class=nb>type</span> <span class=n>MyMenuArgs</span> <span class=o>=</span> <span class=n>Tuple</span><span class=p>[</span><span class=nb>int</span><span class=p>,</span> <span class=nb>str</span><span class=p>]</span>
|
||
<a id=__codelineno-228-12 name=__codelineno-228-12 href=#__codelineno-228-12></a>
|
||
<a id=__codelineno-228-13 name=__codelineno-228-13 href=#__codelineno-228-13></a><span class=k>class</span> <span class=nc>MyMenuSlots</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-228-14 name=__codelineno-228-14 href=#__codelineno-228-14></a> <span class=n>default</span><span class=p>:</span> <span class=n>NotRequired</span><span class=p>[</span><span class=n>Optional</span><span class=p>[</span><span class=n>SlotFunc</span><span class=p>[</span><span class=n>EmptyDict</span><span class=p>]]]</span>
|
||
<a id=__codelineno-228-15 name=__codelineno-228-15 href=#__codelineno-228-15></a>
|
||
<a id=__codelineno-228-16 name=__codelineno-228-16 href=#__codelineno-228-16></a><span class=k>class</span> <span class=nc>MyMenuProps</span><span class=p>(</span><span class=n>TypedDict</span><span class=p>):</span>
|
||
<a id=__codelineno-228-17 name=__codelineno-228-17 href=#__codelineno-228-17></a> <span class=n>vertical</span><span class=p>:</span> <span class=n>NotRequired</span><span class=p>[</span><span class=nb>bool</span><span class=p>]</span>
|
||
<a id=__codelineno-228-18 name=__codelineno-228-18 href=#__codelineno-228-18></a> <span class=n>klass</span><span class=p>:</span> <span class=n>NotRequired</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span>
|
||
<a id=__codelineno-228-19 name=__codelineno-228-19 href=#__codelineno-228-19></a> <span class=n>style</span><span class=p>:</span> <span class=n>NotRequired</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span>
|
||
<a id=__codelineno-228-20 name=__codelineno-228-20 href=#__codelineno-228-20></a>
|
||
<a id=__codelineno-228-21 name=__codelineno-228-21 href=#__codelineno-228-21></a><span class=c1># Define the component</span>
|
||
<a id=__codelineno-228-22 name=__codelineno-228-22 href=#__codelineno-228-22></a><span class=c1># NOTE: Don't forget to set the `registry`!</span>
|
||
<a id=__codelineno-228-23 name=__codelineno-228-23 href=#__codelineno-228-23></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_menu"</span><span class=p>,</span> <span class=n>registry</span><span class=o>=</span><span class=n>comp_registry</span><span class=p>)</span>
|
||
<a id=__codelineno-228-24 name=__codelineno-228-24 href=#__codelineno-228-24></a><span class=k>class</span> <span class=nc>MyMenu</span><span class=p>(</span><span class=n>Component</span><span class=p>[</span><span class=n>MyMenuArgs</span><span class=p>,</span> <span class=n>MyMenuProps</span><span class=p>,</span> <span class=n>MyMenuSlots</span><span class=p>,</span> <span class=n>Any</span><span class=p>,</span> <span class=n>Any</span><span class=p>,</span> <span class=n>Any</span><span class=p>]):</span>
|
||
<a id=__codelineno-228-25 name=__codelineno-228-25 href=#__codelineno-228-25></a> <span class=k>def</span> <span class=nf>get_context_data</span><span class=p>(</span>
|
||
<a id=__codelineno-228-26 name=__codelineno-228-26 href=#__codelineno-228-26></a> <span class=bp>self</span><span class=p>,</span>
|
||
<a id=__codelineno-228-27 name=__codelineno-228-27 href=#__codelineno-228-27></a> <span class=o>*</span><span class=n>args</span><span class=p>,</span>
|
||
<a id=__codelineno-228-28 name=__codelineno-228-28 href=#__codelineno-228-28></a> <span class=n>attrs</span><span class=p>:</span> <span class=n>Optional</span><span class=p>[</span><span class=n>Dict</span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||
<a id=__codelineno-228-29 name=__codelineno-228-29 href=#__codelineno-228-29></a> <span class=p>):</span>
|
||
<a id=__codelineno-228-30 name=__codelineno-228-30 href=#__codelineno-228-30></a> <span class=k>return</span> <span class=p>{</span>
|
||
<a id=__codelineno-228-31 name=__codelineno-228-31 href=#__codelineno-228-31></a> <span class=s2>"attrs"</span><span class=p>:</span> <span class=n>attrs</span><span class=p>,</span>
|
||
<a id=__codelineno-228-32 name=__codelineno-228-32 href=#__codelineno-228-32></a> <span class=p>}</span>
|
||
<a id=__codelineno-228-33 name=__codelineno-228-33 href=#__codelineno-228-33></a>
|
||
<a id=__codelineno-228-34 name=__codelineno-228-34 href=#__codelineno-228-34></a> <span class=n>template</span><span class=p>:</span> <span class=n>types</span><span class=o>.</span><span class=n>django_html</span> <span class=o>=</span> <span class=s2>"""</span>
|
||
<a id=__codelineno-228-35 name=__codelineno-228-35 href=#__codelineno-228-35></a><span class=s2> {# Load django_components template tags #}</span>
|
||
<a id=__codelineno-228-36 name=__codelineno-228-36 href=#__codelineno-228-36></a><span class=s2> {</span><span class=si>% lo</span><span class=s2>ad component_tags %}</span>
|
||
<a id=__codelineno-228-37 name=__codelineno-228-37 href=#__codelineno-228-37></a>
|
||
<a id=__codelineno-228-38 name=__codelineno-228-38 href=#__codelineno-228-38></a><span class=s2> <div {% html_attrs attrs class="my-menu" %}></span>
|
||
<a id=__codelineno-228-39 name=__codelineno-228-39 href=#__codelineno-228-39></a><span class=s2> <div class="my-menu__content"></span>
|
||
<a id=__codelineno-228-40 name=__codelineno-228-40 href=#__codelineno-228-40></a><span class=s2> {</span><span class=si>% s</span><span class=s2>lot "default" default / %}</span>
|
||
<a id=__codelineno-228-41 name=__codelineno-228-41 href=#__codelineno-228-41></a><span class=s2> </div></span>
|
||
<a id=__codelineno-228-42 name=__codelineno-228-42 href=#__codelineno-228-42></a><span class=s2> </div></span>
|
||
<a id=__codelineno-228-43 name=__codelineno-228-43 href=#__codelineno-228-43></a><span class=s2> """</span>
|
||
</code></pre></div> </li> <li> <p>Import the components in <code>apps.py</code></p> <p>Normally, users rely on <a href=#autodiscovery>autodiscovery</a> and <code>COMPONENTS.dirs</code> to load the component files.</p> <p>Since you, as the library author, are not in control of the file system, it is recommended to load the components manually.</p> <p>We recommend doing this in the <code>AppConfig.ready()</code> hook of your <code>apps.py</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-229-1 name=__codelineno-229-1 href=#__codelineno-229-1></a><span class=kn>from</span> <span class=nn>django.apps</span> <span class=kn>import</span> <span class=n>AppConfig</span>
|
||
<a id=__codelineno-229-2 name=__codelineno-229-2 href=#__codelineno-229-2></a>
|
||
<a id=__codelineno-229-3 name=__codelineno-229-3 href=#__codelineno-229-3></a><span class=k>class</span> <span class=nc>MyAppConfig</span><span class=p>(</span><span class=n>AppConfig</span><span class=p>):</span>
|
||
<a id=__codelineno-229-4 name=__codelineno-229-4 href=#__codelineno-229-4></a> <span class=n>default_auto_field</span> <span class=o>=</span> <span class=s2>"django.db.models.BigAutoField"</span>
|
||
<a id=__codelineno-229-5 name=__codelineno-229-5 href=#__codelineno-229-5></a> <span class=n>name</span> <span class=o>=</span> <span class=s2>"myapp"</span>
|
||
<a id=__codelineno-229-6 name=__codelineno-229-6 href=#__codelineno-229-6></a>
|
||
<a id=__codelineno-229-7 name=__codelineno-229-7 href=#__codelineno-229-7></a> <span class=c1># This is the code that gets run when user adds myapp</span>
|
||
<a id=__codelineno-229-8 name=__codelineno-229-8 href=#__codelineno-229-8></a> <span class=c1># to Django's INSTALLED_APPS</span>
|
||
<a id=__codelineno-229-9 name=__codelineno-229-9 href=#__codelineno-229-9></a> <span class=k>def</span> <span class=nf>ready</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||
<a id=__codelineno-229-10 name=__codelineno-229-10 href=#__codelineno-229-10></a> <span class=c1># Import the components that you want to make available</span>
|
||
<a id=__codelineno-229-11 name=__codelineno-229-11 href=#__codelineno-229-11></a> <span class=c1># inside the templates.</span>
|
||
<a id=__codelineno-229-12 name=__codelineno-229-12 href=#__codelineno-229-12></a> <span class=kn>from</span> <span class=nn>myapp.templates</span> <span class=kn>import</span> <span class=p>(</span>
|
||
<a id=__codelineno-229-13 name=__codelineno-229-13 href=#__codelineno-229-13></a> <span class=n>menu</span><span class=p>,</span>
|
||
<a id=__codelineno-229-14 name=__codelineno-229-14 href=#__codelineno-229-14></a> <span class=n>table</span><span class=p>,</span>
|
||
<a id=__codelineno-229-15 name=__codelineno-229-15 href=#__codelineno-229-15></a> <span class=p>)</span>
|
||
</code></pre></div> <p>Note that you can also include any other startup logic within <code>AppConfig.ready()</code>.</p> </li> </ol> <p>And that's it! The next step is to publish it.</p> <h3 id=publishing-component-libraries>Publishing component libraries<a class=headerlink href=#publishing-component-libraries title="Permanent link">¤</a></h3> <p>Once you are ready to share your library, you need to build a distribution and then publish it to PyPI.</p> <p>django_components uses the <a href=https://build.pypa.io/en/stable/ ><code>build</code></a> utility to build a distribution:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-230-1 name=__codelineno-230-1 href=#__codelineno-230-1></a>python<span class=w> </span>-m<span class=w> </span>build<span class=w> </span>--sdist<span class=w> </span>--wheel<span class=w> </span>--outdir<span class=w> </span>dist/<span class=w> </span>.
|
||
</code></pre></div> <p>And to publish to PyPI, you can use <code>twine</code> (<a href=https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives>See Python user guide</a>)</p> <div class=highlight><pre><span></span><code><a id=__codelineno-231-1 name=__codelineno-231-1 href=#__codelineno-231-1></a>twine<span class=w> </span>upload<span class=w> </span>--repository<span class=w> </span>pypi<span class=w> </span>dist/*<span class=w> </span>-u<span class=w> </span>__token__<span class=w> </span>-p<span class=w> </span><PyPI_TOKEN>
|
||
</code></pre></div> <p>Notes on publishing: - The user of the package NEEDS to have installed and configured <code>django_components</code>. - If you use components where the HTML / CSS / JS files are separate, you may need to define <code>MANIFEST.in</code> to include those files with the distribution (<a href=https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html>see user guide</a>).</p> <h3 id=installing-and-using-component-libraries>Installing and using component libraries<a class=headerlink href=#installing-and-using-component-libraries title="Permanent link">¤</a></h3> <p>After the package has been published, all that remains is to install it in other django projects:</p> <ol> <li> <p>Install the package:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-232-1 name=__codelineno-232-1 href=#__codelineno-232-1></a>pip<span class=w> </span>install<span class=w> </span>myapp
|
||
</code></pre></div> </li> <li> <p>Add the package to <code>INSTALLED_APPS</code></p> <div class=highlight><pre><span></span><code><a id=__codelineno-233-1 name=__codelineno-233-1 href=#__codelineno-233-1></a><span class=n>INSTALLED_APPS</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-233-2 name=__codelineno-233-2 href=#__codelineno-233-2></a> <span class=o>...</span>
|
||
<a id=__codelineno-233-3 name=__codelineno-233-3 href=#__codelineno-233-3></a> <span class=s2>"myapp"</span><span class=p>,</span>
|
||
<a id=__codelineno-233-4 name=__codelineno-233-4 href=#__codelineno-233-4></a><span class=p>]</span>
|
||
</code></pre></div> </li> <li> <p>Optionally add the template tags to the <code>builtins</code>, so you don't have to call <code>{% load mytags %}</code> in every template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-234-1 name=__codelineno-234-1 href=#__codelineno-234-1></a><span class=n>TEMPLATES</span> <span class=o>=</span> <span class=p>[</span>
|
||
<a id=__codelineno-234-2 name=__codelineno-234-2 href=#__codelineno-234-2></a> <span class=p>{</span>
|
||
<a id=__codelineno-234-3 name=__codelineno-234-3 href=#__codelineno-234-3></a> <span class=o>...</span><span class=p>,</span>
|
||
<a id=__codelineno-234-4 name=__codelineno-234-4 href=#__codelineno-234-4></a> <span class=s1>'OPTIONS'</span><span class=p>:</span> <span class=p>{</span>
|
||
<a id=__codelineno-234-5 name=__codelineno-234-5 href=#__codelineno-234-5></a> <span class=s1>'context_processors'</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-234-6 name=__codelineno-234-6 href=#__codelineno-234-6></a> <span class=o>...</span>
|
||
<a id=__codelineno-234-7 name=__codelineno-234-7 href=#__codelineno-234-7></a> <span class=p>],</span>
|
||
<a id=__codelineno-234-8 name=__codelineno-234-8 href=#__codelineno-234-8></a> <span class=s1>'builtins'</span><span class=p>:</span> <span class=p>[</span>
|
||
<a id=__codelineno-234-9 name=__codelineno-234-9 href=#__codelineno-234-9></a> <span class=s1>'myapp.templatetags.mytags'</span><span class=p>,</span>
|
||
<a id=__codelineno-234-10 name=__codelineno-234-10 href=#__codelineno-234-10></a> <span class=p>]</span>
|
||
<a id=__codelineno-234-11 name=__codelineno-234-11 href=#__codelineno-234-11></a> <span class=p>},</span>
|
||
<a id=__codelineno-234-12 name=__codelineno-234-12 href=#__codelineno-234-12></a> <span class=p>},</span>
|
||
<a id=__codelineno-234-13 name=__codelineno-234-13 href=#__codelineno-234-13></a><span class=p>]</span>
|
||
</code></pre></div> </li> <li> <p>And, at last, you can use the components in your own project!</p> <div class=highlight><pre><span></span><code><a id=__codelineno-235-1 name=__codelineno-235-1 href=#__codelineno-235-1></a><span class=cp>{%</span> <span class=k>my_menu</span> <span class=nv>title</span><span class=o>=</span><span class=s2>"Abc..."</span> <span class=cp>%}</span>
|
||
<a id=__codelineno-235-2 name=__codelineno-235-2 href=#__codelineno-235-2></a><span class=x> Hello World!</span>
|
||
<a id=__codelineno-235-3 name=__codelineno-235-3 href=#__codelineno-235-3></a><span class=cp>{%</span> <span class=k>endmy_menu</span> <span class=cp>%}</span>
|
||
</code></pre></div> </li> </ol> <h2 id=community-examples>Community examples<a class=headerlink href=#community-examples title="Permanent link">¤</a></h2> <p>One of our goals with <code>django-components</code> is to make it easy to share components between projects. If you have a set of components that you think would be useful to others, please open a pull request to add them to the list below.</p> <ul> <li><a href=https://github.com/iwanalabs/django-htmx-components>django-htmx-components</a>: A set of components for use with <a href=https://htmx.org/ >htmx</a>. Try out the <a href=https://dhc.iwanalabs.com/ >live demo</a>.</li> </ul> <h2 id=contributing-and-development>Contributing and development<a class=headerlink href=#contributing-and-development title="Permanent link">¤</a></h2> <h3 id=install-locally-and-run-the-tests>Install locally and run the tests<a class=headerlink href=#install-locally-and-run-the-tests title="Permanent link">¤</a></h3> <p>Start by forking the project by clicking the <strong>Fork button</strong> up in the right corner in the GitHub . This makes a copy of the repository in your own name. Now you can clone this repository locally and start adding features:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-236-1 name=__codelineno-236-1 href=#__codelineno-236-1></a>git<span class=w> </span>clone<span class=w> </span>https://github.com/<your<span class=w> </span>GitHub<span class=w> </span>username>/django-components.git
|
||
</code></pre></div> <p>To quickly run the tests install the local dependencies by running:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-237-1 name=__codelineno-237-1 href=#__codelineno-237-1></a>pip<span class=w> </span>install<span class=w> </span>-r<span class=w> </span>requirements-dev.txt
|
||
</code></pre></div> <p>Now you can run the tests to make sure everything works as expected:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-238-1 name=__codelineno-238-1 href=#__codelineno-238-1></a>pytest
|
||
</code></pre></div> <p>The library is also tested across many versions of Python and Django. To run tests that way:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-239-1 name=__codelineno-239-1 href=#__codelineno-239-1></a>pyenv<span class=w> </span>install<span class=w> </span>-s<span class=w> </span><span class=m>3</span>.8
|
||
<a id=__codelineno-239-2 name=__codelineno-239-2 href=#__codelineno-239-2></a>pyenv<span class=w> </span>install<span class=w> </span>-s<span class=w> </span><span class=m>3</span>.9
|
||
<a id=__codelineno-239-3 name=__codelineno-239-3 href=#__codelineno-239-3></a>pyenv<span class=w> </span>install<span class=w> </span>-s<span class=w> </span><span class=m>3</span>.10
|
||
<a id=__codelineno-239-4 name=__codelineno-239-4 href=#__codelineno-239-4></a>pyenv<span class=w> </span>install<span class=w> </span>-s<span class=w> </span><span class=m>3</span>.11
|
||
<a id=__codelineno-239-5 name=__codelineno-239-5 href=#__codelineno-239-5></a>pyenv<span class=w> </span>install<span class=w> </span>-s<span class=w> </span><span class=m>3</span>.12
|
||
<a id=__codelineno-239-6 name=__codelineno-239-6 href=#__codelineno-239-6></a>pyenv<span class=w> </span><span class=nb>local</span><span class=w> </span><span class=m>3</span>.8<span class=w> </span><span class=m>3</span>.9<span class=w> </span><span class=m>3</span>.10<span class=w> </span><span class=m>3</span>.11<span class=w> </span><span class=m>3</span>.12
|
||
<a id=__codelineno-239-7 name=__codelineno-239-7 href=#__codelineno-239-7></a>tox<span class=w> </span>-p
|
||
</code></pre></div> <h3 id=running-playwright-tests>Running Playwright tests<a class=headerlink href=#running-playwright-tests title="Permanent link">¤</a></h3> <p>We use <a href=https://playwright.dev/python/docs/intro>Playwright</a> for end-to-end tests. You will therefore need to install Playwright to be able to run these tests.</p> <p>Luckily, Playwright makes it very easy:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-240-1 name=__codelineno-240-1 href=#__codelineno-240-1></a>pip<span class=w> </span>install<span class=w> </span>-r<span class=w> </span>requirements-dev.txt
|
||
<a id=__codelineno-240-2 name=__codelineno-240-2 href=#__codelineno-240-2></a>playwright<span class=w> </span>install<span class=w> </span>chromium<span class=w> </span>--with-deps
|
||
</code></pre></div> <p>After Playwright is ready, simply run the tests with <code>tox</code>: <div class=highlight><pre><span></span><code><a id=__codelineno-241-1 name=__codelineno-241-1 href=#__codelineno-241-1></a>tox
|
||
</code></pre></div></p> <h3 id=developing-against-live-django-app>Developing against live Django app<a class=headerlink href=#developing-against-live-django-app title="Permanent link">¤</a></h3> <p>How do you check that your changes to django-components project will work in an actual Django project?</p> <p>Use the <a href=https://github.com/EmilStenstrom/django-components/tree/master/sampleproject/ >sampleproject</a> demo project to validate the changes:</p> <ol> <li>Navigate to <a href=https://github.com/EmilStenstrom/django-components/tree/master/sampleproject/ >sampleproject</a> directory:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-242-1 name=__codelineno-242-1 href=#__codelineno-242-1></a><span class=nb>cd</span><span class=w> </span>sampleproject
|
||
</code></pre></div> <ol> <li>Install dependencies from the <a href=https://github.com/EmilStenstrom/django-components/blob/master/sampleproject/requirements.txt>requirements.txt</a> file:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-243-1 name=__codelineno-243-1 href=#__codelineno-243-1></a>pip<span class=w> </span>install<span class=w> </span>-r<span class=w> </span>requirements.txt
|
||
</code></pre></div> <ol> <li>Link to your local version of django-components:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-244-1 name=__codelineno-244-1 href=#__codelineno-244-1></a>pip<span class=w> </span>install<span class=w> </span>-e<span class=w> </span>..
|
||
</code></pre></div> <p>NOTE: The path (in this case <code>..</code>) must point to the directory that has the <code>setup.py</code> file.</p> <ol> <li>Start Django server <div class=highlight><pre><span></span><code><a id=__codelineno-245-1 name=__codelineno-245-1 href=#__codelineno-245-1></a>python<span class=w> </span>manage.py<span class=w> </span>runserver
|
||
</code></pre></div></li> </ol> <p>Once the server is up, it should be available at <a href=http://127.0.0.1:8000>http://127.0.0.1:8000</a>.</p> <p>To display individual components, add them to the <code>urls.py</code>, like in the case of <a href=http://127.0.0.1:8000/greeting>http://127.0.0.1:8000/greeting</a></p> <h3 id=building-js-code>Building JS code<a class=headerlink href=#building-js-code title="Permanent link">¤</a></h3> <p>django_components uses a bit of JS code to: - Manage the loading of JS and CSS files used by the components - Allow to pass data from Python to JS</p> <p>When you make changes to this JS code, you also need to compile it:</p> <ol> <li>Make sure you are inside <code>src/django_components_js</code>:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-246-1 name=__codelineno-246-1 href=#__codelineno-246-1></a><span class=nb>cd</span><span class=w> </span>src/django_components_js
|
||
</code></pre></div> <ol> <li>Install the JS dependencies</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-247-1 name=__codelineno-247-1 href=#__codelineno-247-1></a>npm<span class=w> </span>install
|
||
</code></pre></div> <ol> <li>Compile the JS/TS code:</li> </ol> <div class=highlight><pre><span></span><code><a id=__codelineno-248-1 name=__codelineno-248-1 href=#__codelineno-248-1></a>python<span class=w> </span>build.py
|
||
</code></pre></div> <p>The script will combine all JS/TS code into a single <code>.js</code> file, minify it, and copy it to <code>django_components/static/django_components/django_components.min.js</code>.</p> <h3 id=packaging-and-publishing>Packaging and publishing<a class=headerlink href=#packaging-and-publishing title="Permanent link">¤</a></h3> <p>To package the library into a distribution that can be published to PyPI, run:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-249-1 name=__codelineno-249-1 href=#__codelineno-249-1></a><span class=c1># Install pypa/build</span>
|
||
<a id=__codelineno-249-2 name=__codelineno-249-2 href=#__codelineno-249-2></a>python<span class=w> </span>-m<span class=w> </span>pip<span class=w> </span>install<span class=w> </span>build<span class=w> </span>--user
|
||
<a id=__codelineno-249-3 name=__codelineno-249-3 href=#__codelineno-249-3></a><span class=c1># Build a binary wheel and a source tarball</span>
|
||
<a id=__codelineno-249-4 name=__codelineno-249-4 href=#__codelineno-249-4></a>python<span class=w> </span>-m<span class=w> </span>build<span class=w> </span>--sdist<span class=w> </span>--wheel<span class=w> </span>--outdir<span class=w> </span>dist/<span class=w> </span>.
|
||
</code></pre></div> <p>To publish the package to PyPI, use <code>twine</code> (<a href=https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives>See Python user guide</a>): <div class=highlight><pre><span></span><code><a id=__codelineno-250-1 name=__codelineno-250-1 href=#__codelineno-250-1></a>twine<span class=w> </span>upload<span class=w> </span>--repository<span class=w> </span>pypi<span class=w> </span>dist/*<span class=w> </span>-u<span class=w> </span>__token__<span class=w> </span>-p<span class=w> </span><PyPI_TOKEN>
|
||
</code></pre></div></p> <p><a href=https://github.com/EmilStenstrom/django-components/discussions/557#discussioncomment-10179141>See the full workflow here.</a></p> <h3 id=development-guides>Development guides<a class=headerlink href=#development-guides title="Permanent link">¤</a></h3> <p>Deep dive into how django_components' features are implemented.</p> <ul> <li><a href=https://github.com/EmilStenstrom/django-components/blob/master/docs/devguides/slot_rendering.md>Slot rendering</a></li> <li><a href=https://github.com/EmilStenstrom/django-components/blob/master/docs/devguides/slots_and_blocks.md>Slots and blocks</a></li> <li><a href=https://github.com/EmilStenstrom/django-components/blob/master/docs/devguides/dependency_mgmt.md>JS and CSS dependency management</a></li> </ul> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-11-26T17:21:12+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-11-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Contributors> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 4a4 4 0 0 1 4 4 4 4 0 0 1-4 4 4 4 0 0 1-4-4 4 4 0 0 1 4-4m0 10c4.42 0 8 1.79 8 4v2H4v-2c0-2.21 3.58-4 8-4"/></svg> </span> <nav> <a href=mailto:juraj.oravec.josefson@gmail.com>Juro Oravec</a> </nav> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=CHANGELOG/ class="md-footer__link md-footer__link--next" aria-label="Next: Changelog"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Changelog </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/EmilStenstrom/django-components target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> <a href=https://pypi.org/project/django-components/ target=_blank rel=noopener title=pypi.org class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6M286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3M167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4m-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <div class=md-progress data-md-component=progress role=progressbar></div> <script id=__config type=application/json>{"base": ".", "features": ["content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.expand", "navigation.footer", "navigation.instant", "navigation.instant.progress", "navigation.indexes", "navigation.sections", "navigation.tracking", "navigation.top", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"alias": true, "default": ["dev"], "provider": "mike"}}</script> <script src=assets/javascripts/bundle.83f73b43.min.js></script> <script src=assets/_markdown_exec_pyodide.js></script> <script src=js/timeago.min.js></script> <script src=js/timeago_mkdocs_material.js></script> </body> </html> |