mirror of
https://github.com/django-components/django-components.git
synced 2025-09-19 12:19:44 +00:00
213 lines
No EOL
105 KiB
HTML
213 lines
No EOL
105 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://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/ rel=canonical><link href=../template_tag_syntax/ rel=prev><link href=../component_views_urls/ rel=next><link rel=icon href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.6.16"><title>HTML attributes - Django-Components</title><link rel=stylesheet href=../../../assets/stylesheets/main.7e37652d.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><link rel=stylesheet href=../../../css/style.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="HTML attributes - Django-Components"><meta property=og:description content="A way to create simple reusable template components in Django."><meta property=og:image content=https://django-components.github.io/django-components/latest/assets/images/social/concepts/fundamentals/html_attributes.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://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/ property=og:url><meta name=twitter:card content=summary_large_image><meta name=twitter:title content="HTML attributes - Django-Components"><meta name=twitter:description content="A way to create simple reusable template components in Django."><meta name=twitter:image content=https://django-components.github.io/django-components/latest/assets/images/social/concepts/fundamentals/html_attributes.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=#summary class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class=md-header 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> HTML attributes </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/django-components/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 512 512"><!-- Font Awesome Free 7.0.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 2025 Fonticons, Inc.--><path fill=currentColor d="M173.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.9M252.8 8C114.1 8 8 113.3 8 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.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.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> django-components/django-components </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../../../overview/welcome/ class=md-tabs__link> Overview </a> </li> <li class=md-tabs__item> <a href=../../../getting_started/your_first_component/ class=md-tabs__link> Getting Started </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../single_file_components/ class=md-tabs__link> Concepts </a> </li> <li class=md-tabs__item> <a href=../../../guides/setup/caching/ class=md-tabs__link> Guides </a> </li> <li class=md-tabs__item> <a href=../../../reference/api/ class=md-tabs__link> API Documentation </a> </li> <li class=md-tabs__item> <a href=../../../release_notes/ class=md-tabs__link> Release Notes </a> </li> </ul> </div> </nav> <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 md-nav--lifted" 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/django-components/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 512 512"><!-- Font Awesome Free 7.0.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 2025 Fonticons, Inc.--><path fill=currentColor d="M173.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.9M252.8 8C114.1 8 8 113.3 8 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.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.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> django-components/django-components </div> </a> </div> <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_1> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex=0> <span class=md-ellipsis> Overview </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=false> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Overview </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../overview/welcome/ class=md-nav__link> <span class=md-ellipsis> Welcome to Django Components </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/compatibility/ class=md-nav__link> <span class=md-ellipsis> Compatibility </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/installation/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/security_notes/ class=md-nav__link> <span class=md-ellipsis> Security notes 🚨 </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/migrating/ class=md-nav__link> <span class=md-ellipsis> Migrating </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/community/ class=md-nav__link> <span class=md-ellipsis> Community </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/contributing/ class=md-nav__link> <span class=md-ellipsis> Contributing </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/development/ class=md-nav__link> <span class=md-ellipsis> Development </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/performance/ class=md-nav__link> <span class=md-ellipsis> Performance </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/code_of_conduct/ class=md-nav__link> <span class=md-ellipsis> Code of Conduct </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/license/ class=md-nav__link> <span class=md-ellipsis> License </span> </a> </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> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex=0> <span class=md-ellipsis> Getting Started </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> Getting Started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../getting_started/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=../../../getting_started/adding_js_and_css/ class=md-nav__link> <span class=md-ellipsis> Adding JS and CSS </span> </a> </li> <li class=md-nav__item> <a href=../../../getting_started/components_in_templates/ class=md-nav__link> <span class=md-ellipsis> Components in templates </span> </a> </li> <li class=md-nav__item> <a href=../../../getting_started/parametrising_components/ class=md-nav__link> <span class=md-ellipsis> Parametrising components </span> </a> </li> <li class=md-nav__item> <a href=../../../getting_started/adding_slots/ class=md-nav__link> <span class=md-ellipsis> Adding slots </span> </a> </li> <li class=md-nav__item> <a href=../../../getting_started/rendering_components/ class=md-nav__link> <span class=md-ellipsis> Rendering components </span> </a> </li> </ul> </nav> </li> <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_3 checked> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex> <span class=md-ellipsis> Concepts </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=true> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Concepts </label> <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_3_1 checked> <label class=md-nav__link for=__nav_3_1 id=__nav_3_1_label tabindex> <span class=md-ellipsis> Fundamentals </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_1_label aria-expanded=true> <label class=md-nav__title for=__nav_3_1> <span class="md-nav__icon md-icon"></span> Fundamentals </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../single_file_components/ class=md-nav__link> <span class=md-ellipsis> Single-file components </span> </a> </li> <li class=md-nav__item> <a href=../html_js_css_files/ class=md-nav__link> <span class=md-ellipsis> HTML / JS / CSS files </span> </a> </li> <li class=md-nav__item> <a href=../html_js_css_variables/ class=md-nav__link> <span class=md-ellipsis> HTML / JS / CSS variables </span> </a> </li> <li class=md-nav__item> <a href=../secondary_js_css_files/ class=md-nav__link> <span class=md-ellipsis> Secondary JS / CSS files </span> </a> </li> <li class=md-nav__item> <a href=../component_defaults/ class=md-nav__link> <span class=md-ellipsis> Component defaults </span> </a> </li> <li class=md-nav__item> <a href=../render_api/ class=md-nav__link> <span class=md-ellipsis> Render API </span> </a> </li> <li class=md-nav__item> <a href=../rendering_components/ class=md-nav__link> <span class=md-ellipsis> Rendering components </span> </a> </li> <li class=md-nav__item> <a href=../slots/ class=md-nav__link> <span class=md-ellipsis> Slots </span> </a> </li> <li class=md-nav__item> <a href=../template_tag_syntax/ class=md-nav__link> <span class=md-ellipsis> Template tag syntax </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> HTML attributes </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> HTML attributes </span> </a> <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=#summary class=md-nav__link> <span class=md-ellipsis> Summary </span> </a> </li> <li class=md-nav__item> <a href=#usage class=md-nav__link> <span class=md-ellipsis> Usage </span> </a> <nav class=md-nav aria-label=Usage> <ul class=md-nav__list> <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=#removing-attributes class=md-nav__link> <span class=md-ellipsis> Removing 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=#merging-class-attributes class=md-nav__link> <span class=md-ellipsis> Merging class attributes </span> </a> </li> <li class=md-nav__item> <a href=#merging-style-attributes class=md-nav__link> <span class=md-ellipsis> Merging style attributes </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#usage-outside-of-templates class=md-nav__link> <span class=md-ellipsis> Usage outside of templates </span> </a> <nav class=md-nav aria-label="Usage outside of templates"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#merging-attributes class=md-nav__link> <span class=md-ellipsis> Merging attributes </span> </a> </li> <li class=md-nav__item> <a href=#formatting-attributes class=md-nav__link> <span class=md-ellipsis> Formatting attributes </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#cheat-sheet class=md-nav__link> <span class=md-ellipsis> Cheat sheet </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_views_urls/ class=md-nav__link> <span class=md-ellipsis> Component views and URLs </span> </a> </li> <li class=md-nav__item> <a href=../http_request/ class=md-nav__link> <span class=md-ellipsis> HTTP Request </span> </a> </li> <li class=md-nav__item> <a href=../typing_and_validation/ class=md-nav__link> <span class=md-ellipsis> Typing and validation </span> </a> </li> <li class=md-nav__item> <a href=../subclassing_components/ class=md-nav__link> <span class=md-ellipsis> Subclassing components </span> </a> </li> <li class=md-nav__item> <a href=../autodiscovery/ class=md-nav__link> <span class=md-ellipsis> Autodiscovery </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_3_2> <label class=md-nav__link for=__nav_3_2 id=__nav_3_2_label tabindex> <span class=md-ellipsis> Advanced </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_2_label aria-expanded=false> <label class=md-nav__title for=__nav_3_2> <span class="md-nav__icon md-icon"></span> Advanced </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../advanced/rendering_js_css/ class=md-nav__link> <span class=md-ellipsis> Rendering JS / CSS </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/html_fragments/ class=md-nav__link> <span class=md-ellipsis> HTML fragments </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/provide_inject/ class=md-nav__link> <span class=md-ellipsis> Prop drilling and provide / inject </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/hooks/ class=md-nav__link> <span class=md-ellipsis> Lifecycle hooks </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/component_registry/ class=md-nav__link> <span class=md-ellipsis> Registering components </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/component_caching/ class=md-nav__link> <span class=md-ellipsis> Component caching </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/component_context_scope/ class=md-nav__link> <span class=md-ellipsis> Component context and scope </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/template_tags/ class=md-nav__link> <span class=md-ellipsis> Custom template tags </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/tag_formatters/ class=md-nav__link> <span class=md-ellipsis> Tag formatters </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/extensions/ class=md-nav__link> <span class=md-ellipsis> Extensions </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/component_libraries/ class=md-nav__link> <span class=md-ellipsis> Component libraries </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_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Guides </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_4_1> <label class=md-nav__link for=__nav_4_1 id=__nav_4_1_label tabindex=0> <span class=md-ellipsis> Setup </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_1_label aria-expanded=false> <label class=md-nav__title for=__nav_4_1> <span class="md-nav__icon md-icon"></span> Setup </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../guides/setup/caching/ class=md-nav__link> <span class=md-ellipsis> Caching </span> </a> </li> <li class=md-nav__item> <a href=../../../guides/setup/development_server/ class=md-nav__link> <span class=md-ellipsis> Development server </span> </a> </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_4_2> <label class=md-nav__link for=__nav_4_2 id=__nav_4_2_label tabindex=0> <span class=md-ellipsis> Other </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_2_label aria-expanded=false> <label class=md-nav__title for=__nav_4_2> <span class="md-nav__icon md-icon"></span> Other </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../guides/other/troubleshooting/ class=md-nav__link> <span class=md-ellipsis> Troubleshooting </span> </a> </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_4_3> <label class=md-nav__link for=__nav_4_3 id=__nav_4_3_label tabindex=0> <span class=md-ellipsis> Dev Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_3_label aria-expanded=false> <label class=md-nav__title for=__nav_4_3> <span class="md-nav__icon md-icon"></span> Dev Guides </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../guides/devguides/dependency_mgmt/ class=md-nav__link> <span class=md-ellipsis> JS and CSS rendering </span> </a> </li> <li class=md-nav__item> <a href=../../../guides/devguides/slot_rendering/ class=md-nav__link> <span class=md-ellipsis> Slot rendering </span> </a> </li> <li class=md-nav__item> <a href=../../../guides/devguides/slots_and_blocks/ class=md-nav__link> <span class=md-ellipsis> Using slot and block tags </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_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> API Documentation </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> API Documentation </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../reference/api/ class=md-nav__link> <span class=md-ellipsis> API </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/commands/ class=md-nav__link> <span class=md-ellipsis> CLI commands </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/components/ class=md-nav__link> <span class=md-ellipsis> Components </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/exceptions/ class=md-nav__link> <span class=md-ellipsis> Exceptions </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/extension_hooks/ class=md-nav__link> <span class=md-ellipsis> Extension hooks </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/extension_commands/ class=md-nav__link> <span class=md-ellipsis> Extension commands API </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/extension_urls/ class=md-nav__link> <span class=md-ellipsis> Extension URLs API </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/settings/ class=md-nav__link> <span class=md-ellipsis> Settings </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/signals/ class=md-nav__link> <span class=md-ellipsis> Signals </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/tag_formatters/ class=md-nav__link> <span class=md-ellipsis> Tag formatters </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/template_tags/ class=md-nav__link> <span class=md-ellipsis> Template tags </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/template_variables/ class=md-nav__link> <span class=md-ellipsis> Template variables </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/urls/ class=md-nav__link> <span class=md-ellipsis> URLs </span> </a> </li> <li class=md-nav__item> <a href=../../../reference/testing_api/ class=md-nav__link> <span class=md-ellipsis> Testing API </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../release_notes/ class=md-nav__link> <span class=md-ellipsis> Release Notes </span> </a> </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=#summary class=md-nav__link> <span class=md-ellipsis> Summary </span> </a> </li> <li class=md-nav__item> <a href=#usage class=md-nav__link> <span class=md-ellipsis> Usage </span> </a> <nav class=md-nav aria-label=Usage> <ul class=md-nav__list> <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=#removing-attributes class=md-nav__link> <span class=md-ellipsis> Removing 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=#merging-class-attributes class=md-nav__link> <span class=md-ellipsis> Merging class attributes </span> </a> </li> <li class=md-nav__item> <a href=#merging-style-attributes class=md-nav__link> <span class=md-ellipsis> Merging style attributes </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#usage-outside-of-templates class=md-nav__link> <span class=md-ellipsis> Usage outside of templates </span> </a> <nav class=md-nav aria-label="Usage outside of templates"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#merging-attributes class=md-nav__link> <span class=md-ellipsis> Merging attributes </span> </a> </li> <li class=md-nav__item> <a href=#formatting-attributes class=md-nav__link> <span class=md-ellipsis> Formatting attributes </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#cheat-sheet class=md-nav__link> <span class=md-ellipsis> Cheat sheet </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> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <a href=https://github.com/django-components/django-components/edit/master/docs/concepts/fundamentals/html_attributes.md title="Edit this page" class="md-content__button md-icon" rel=edit> <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/django-components/django-components/raw/master/docs/concepts/fundamentals/html_attributes.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>HTML attributes</h1> <p><em>New in version 0.74</em>:</p> <p>You can use the <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag to render various data as <code>key="value"</code> HTML attributes.</p> <p><a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag is versatile, allowing you to define HTML attributes however you need:</p> <ul> <li>Define attributes within the HTML template</li> <li>Define attributes in Python code</li> <li>Merge attributes from multiple sources</li> <li>Boolean attributes</li> <li>Append attributes</li> <li>Remove attributes</li> <li>Define default attributes</li> </ul> <p>From v0.135 onwards, <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag also supports merging <a href=https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style><code>style</code></a> and <a href=https://developer.mozilla.org/en-US/docs/Web/SVG/Reference/Attribute/class><code>class</code></a> attributes the same way <a href=https://vuejs.org/guide/essentials/class-and-style>how Vue does</a>.</p> <p>To get started, let's consider a simple example. If you have a template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-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-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a><span class=x></div></span>
|
|
</code></pre></div> <p>You can rewrite it with the <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>class</span><span class=o>=</span><span class=nv>classes</span> <span class=nv>data-id</span><span class=o>=</span><span class=nv>my_id</span> <span class=cp>%}</span><span class=x>></span>
|
|
<a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=x></div></span>
|
|
</code></pre></div> <p>The <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag accepts any number of keyword arguments, which will be merged and rendered as HTML attributes:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=x><div class="text-red" data-id="123"></span>
|
|
<a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a><span class=x></div></span>
|
|
</code></pre></div> <p>Moreover, the <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag accepts two positional arguments:</p> <ul> <li><code>attrs</code> - a dictionary of attributes to be rendered</li> <li><code>defaults</code> - a dictionary of default attributes</li> </ul> <p>You can use this for example to allow users of your component to add extra attributes. We achieve this by capturing the extra attributes and passing them to the <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag as a dictionary:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
|
<a id=__codelineno-3-2 name=__codelineno-3-2 href=#__codelineno-3-2></a><span class=k>class</span><span class=w> </span><span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
|
<a id=__codelineno-3-3 name=__codelineno-3-3 href=#__codelineno-3-3></a> <span class=c1># Pass all kwargs as `attrs`</span>
|
|
<a id=__codelineno-3-4 name=__codelineno-3-4 href=#__codelineno-3-4></a> <span class=k>def</span><span class=w> </span><span class=nf>get_template_data</span><span class=p>(</span><span class=bp>self</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>context</span><span class=p>):</span>
|
|
<a id=__codelineno-3-5 name=__codelineno-3-5 href=#__codelineno-3-5></a> <span class=k>return</span> <span class=p>{</span>
|
|
<a id=__codelineno-3-6 name=__codelineno-3-6 href=#__codelineno-3-6></a> <span class=s2>"attrs"</span><span class=p>:</span> <span class=n>kwargs</span><span class=p>,</span>
|
|
<a id=__codelineno-3-7 name=__codelineno-3-7 href=#__codelineno-3-7></a> <span class=s2>"classes"</span><span class=p>:</span> <span class=s2>"text-red"</span><span class=p>,</span>
|
|
<a id=__codelineno-3-8 name=__codelineno-3-8 href=#__codelineno-3-8></a> <span class=s2>"my_id"</span><span class=p>:</span> <span class=mi>123</span><span class=p>,</span>
|
|
<a id=__codelineno-3-9 name=__codelineno-3-9 href=#__codelineno-3-9></a> <span class=p>}</span>
|
|
<a id=__codelineno-3-10 name=__codelineno-3-10 href=#__codelineno-3-10></a>
|
|
<a id=__codelineno-3-11 name=__codelineno-3-11 href=#__codelineno-3-11></a> <span class=nv>template</span><span class=p>:</span> <span class=nc>t.django_html</span> <span class=o>=</span> <span class=sd>"""</span>
|
|
<a id=__codelineno-3-12 name=__codelineno-3-12 href=#__codelineno-3-12></a> <span class=c>{# Pass the extra attributes to `html_attrs` #}</span>
|
|
<a id=__codelineno-3-13 name=__codelineno-3-13 href=#__codelineno-3-13></a> <span class=p><</span><span class=nt>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=nv>classes</span> <span class=nv>data-id</span><span class=o>=</span><span class=nv>my_id</span> <span class=cp>%}</span><span class=p>></span>
|
|
<a id=__codelineno-3-14 name=__codelineno-3-14 href=#__codelineno-3-14></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
|
<a id=__codelineno-3-15 name=__codelineno-3-15 href=#__codelineno-3-15></a> <span class=sd>"""</span>
|
|
</code></pre></div> <p>This way you can render <code>MyComp</code> with extra attributes:</p> <p>Either via Django template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span>
|
|
<a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a> <span class=nv>id</span><span class=o>=</span><span class=s2>"example"</span>
|
|
<a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a> <span class=nv>class</span><span class=o>=</span><span class=s2>"pa-4"</span>
|
|
<a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a> <span class=nv>style</span><span class=o>=</span><span class=s2>"color: red;"</span>
|
|
<a id=__codelineno-4-5 name=__codelineno-4-5 href=#__codelineno-4-5></a><span class=cp>%}</span>
|
|
</code></pre></div> <p>Or via Python:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a><span class=n>MyComp</span><span class=o>.</span><span class=n>render</span><span class=p>(</span>
|
|
<a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span>
|
|
<a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a> <span class=s2>"id"</span><span class=p>:</span> <span class=s2>"example"</span><span class=p>,</span>
|
|
<a id=__codelineno-5-4 name=__codelineno-5-4 href=#__codelineno-5-4></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"pa-4"</span><span class=p>,</span>
|
|
<a id=__codelineno-5-5 name=__codelineno-5-5 href=#__codelineno-5-5></a> <span class=s2>"style"</span><span class=p>:</span> <span class=s2>"color: red;"</span><span class=p>,</span>
|
|
<a id=__codelineno-5-6 name=__codelineno-5-6 href=#__codelineno-5-6></a> <span class=p>}</span>
|
|
<a id=__codelineno-5-7 name=__codelineno-5-7 href=#__codelineno-5-7></a><span class=p>)</span>
|
|
</code></pre></div> <p>In both cases, the attributes will be merged and rendered as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a><span class=p><</span><span class=nt>div</span> <span class=na>id</span><span class=o>=</span><span class=s>"example"</span> <span class=na>class</span><span class=o>=</span><span class=s>"text-red pa-4"</span> <span class=na>style</span><span class=o>=</span><span class=s>"color: red;"</span> <span class=na>data-id</span><span class=o>=</span><span class=s>"123"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <h3 id=summary>Summary<a class=headerlink href=#summary title="Permanent link">¤</a></h3> <ol> <li> <p>The two arguments, <code>attrs</code> and <code>defaults</code>, can be passed as positional args:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span> <span class=nv>defaults</span> <span class=nv>key</span><span class=o>=</span><span class=nv>val</span> <span class=cp>%}</span>
|
|
</code></pre></div> <p>or as kwargs:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>key</span><span class=o>=</span><span class=nv>val</span> <span class=nv>defaults</span><span class=o>=</span><span class=nv>defaults</span> <span class=nv>attrs</span><span class=o>=</span><span class=nv>attrs</span> <span class=cp>%}</span>
|
|
</code></pre></div> </li> <li> <p>Both <code>attrs</code> and <code>defaults</code> are optional and can be omitted.</p> </li> <li> <p>Both <code>attrs</code> and <code>defaults</code> are dictionaries. As such, there's multiple ways to define them:</p> <ul> <li> <p>By referencing a variable:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-9-1 name=__codelineno-9-1 href=#__codelineno-9-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span><span class=o>=</span><span class=nv>attrs</span> <span class=cp>%}</span>
|
|
</code></pre></div> </li> <li> <p>By defining a literal dictionary:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span><span class=o>={</span><span class=s2>"key"</span><span class=o>:</span> <span class=nv>value</span><span class=o>}</span> <span class=cp>%}</span>
|
|
</code></pre></div> </li> <li> <p>Or by defining the <a href=../template_tag_syntax/#pass-dictonary-by-its-key-value-pairs>dictionary keys</a>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span><span class=o>:</span><span class=nv>key</span><span class=o>=</span><span class=nv>value</span> <span class=cp>%}</span>
|
|
</code></pre></div> </li> </ul> </li> <li> <p>All other kwargs are merged and can be repeated.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"text-red"</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"pa-4"</span> <span class=cp>%}</span>
|
|
</code></pre></div> <p>Will render:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"text-red pa-4"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> </ol> <h2 id=usage>Usage<a class=headerlink href=#usage title="Permanent link">¤</a></h2> <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-14-1 name=__codelineno-14-1 href=#__codelineno-14-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>
|
|
<a id=__codelineno-14-2 name=__codelineno-14-2 href=#__codelineno-14-2></a><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 <a href=../../../reference/template_tags#html_attrs><code>html_attrs</code></a> tag or <a href=../../../reference/api#django_components.format_attributes><code>format_attributes</code></a> works the same way - an attribute set to <code>True</code> is rendered without the value, and an attribute set to <code>False</code> is not rendered at all.</p> <p>So given this input:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
|
<a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a> <span class=s2>"disabled"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
|
<a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a> <span class=s2>"autofocus"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
|
<a id=__codelineno-15-4 name=__codelineno-15-4 href=#__codelineno-15-4></a><span class=p>}</span>
|
|
</code></pre></div> <p>And template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-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-16-2 name=__codelineno-16-2 href=#__codelineno-16-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-17-1 name=__codelineno-17-1 href=#__codelineno-17-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=removing-attributes>Removing attributes<a class=headerlink href=#removing-attributes title="Permanent link">¤</a></h3> <p>Given how the boolean attributes work, you can "remove" or prevent an attribute from being rendered by setting it to <code>False</code> or <code>None</code>.</p> <p>So given this input:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
|
<a id=__codelineno-18-2 name=__codelineno-18-2 href=#__codelineno-18-2></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"text-green"</span><span class=p>,</span>
|
|
<a id=__codelineno-18-3 name=__codelineno-18-3 href=#__codelineno-18-3></a> <span class=s2>"required"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
|
<a id=__codelineno-18-4 name=__codelineno-18-4 href=#__codelineno-18-4></a> <span class=s2>"data-id"</span><span class=p>:</span> <span class=kc>None</span><span class=p>,</span>
|
|
<a id=__codelineno-18-5 name=__codelineno-18-5 href=#__codelineno-18-5></a><span class=p>}</span>
|
|
</code></pre></div> <p>And template:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-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-19-2 name=__codelineno-19-2 href=#__codelineno-19-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-20-1 name=__codelineno-20-1 href=#__codelineno-20-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=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 positional argument to set the defaults.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-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-21-2 name=__codelineno-21-2 href=#__codelineno-21-2></a><span class=x> ...</span>
|
|
<a id=__codelineno-21-3 name=__codelineno-21-3 href=#__codelineno-21-3></a><span class=x></div></span>
|
|
</code></pre></div> <p>In the example above, if <code>attrs</code> contains a certain key, e.g. the <code>class</code> key, <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> will render:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-22-1 name=__codelineno-22-1 href=#__codelineno-22-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"{{ attrs.class }}"</span><span class=p>></span>
|
|
<a id=__codelineno-22-2 name=__codelineno-22-2 href=#__codelineno-22-2></a> ...
|
|
<a id=__codelineno-22-3 name=__codelineno-22-3 href=#__codelineno-22-3></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <p>Otherwise, <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> will render:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-23-1 name=__codelineno-23-1 href=#__codelineno-23-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"{{ defaults.class }}"</span><span class=p>></span>
|
|
<a id=__codelineno-23-2 name=__codelineno-23-2 href=#__codelineno-23-2></a> ...
|
|
<a id=__codelineno-23-3 name=__codelineno-23-3 href=#__codelineno-23-3></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <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.</p> <p>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 <code>class</code> attribute.</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-24-1 name=__codelineno-24-1 href=#__codelineno-24-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
|
<a id=__codelineno-24-2 name=__codelineno-24-2 href=#__codelineno-24-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-24-3 name=__codelineno-24-3 href=#__codelineno-24-3></a><span class=p>}</span>
|
|
</code></pre></div> <p>And on <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag, we set the key <code>class</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-25-1 name=__codelineno-25-1 href=#__codelineno-25-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-25-2 name=__codelineno-25-2 href=#__codelineno-25-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-26-1 name=__codelineno-26-1 href=#__codelineno-26-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-27-1 name=__codelineno-27-1 href=#__codelineno-27-1></a><span class=c>{# my_var = "class-from-var text-red" #}</span>
|
|
<a id=__codelineno-27-2 name=__codelineno-27-2 href=#__codelineno-27-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-27-3 name=__codelineno-27-3 href=#__codelineno-27-3></a><span class=x></div></span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-28-1 name=__codelineno-28-1 href=#__codelineno-28-1></a><span class=p><</span><span class=nt>div</span>
|
|
<a id=__codelineno-28-2 name=__codelineno-28-2 href=#__codelineno-28-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-28-3 name=__codelineno-28-3 href=#__codelineno-28-3></a><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <h3 id=merging-class-attributes>Merging <code>class</code> attributes<a class=headerlink href=#merging-class-attributes title="Permanent link">¤</a></h3> <p>The <code>class</code> attribute can be specified as a string of class names as usual.</p> <p>If you want granular control over individual class names, you can use a dictionary.</p> <ul> <li> <p><strong>String</strong>: Used as is.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-29-1 name=__codelineno-29-1 href=#__codelineno-29-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"my-class other-class"</span> <span class=cp>%}</span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-30-1 name=__codelineno-30-1 href=#__codelineno-30-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"my-class other-class"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Dictionary</strong>: Keys are the class names, and values are booleans. Only keys with truthy values are rendered.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-31-1 name=__codelineno-31-1 href=#__codelineno-31-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>class</span><span class=o>={</span>
|
|
<a id=__codelineno-31-2 name=__codelineno-31-2 href=#__codelineno-31-2></a> <span class=s2>"extra-class"</span><span class=o>:</span> <span class=kp>True</span><span class=o>,</span>
|
|
<a id=__codelineno-31-3 name=__codelineno-31-3 href=#__codelineno-31-3></a> <span class=s2>"other-class"</span><span class=o>:</span> <span class=kp>False</span><span class=o>,</span>
|
|
<a id=__codelineno-31-4 name=__codelineno-31-4 href=#__codelineno-31-4></a><span class=o>}</span> <span class=cp>%}</span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-32-1 name=__codelineno-32-1 href=#__codelineno-32-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"extra-class"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> </ul> <p>If a certain class is specified multiple times, it's the last instance that decides whether the class is rendered or not.</p> <p><strong>Example:</strong></p> <p>In this example, the <code>other-class</code> is specified twice. The last instance is <code>{"other-class": False}</code>, so the class is not rendered.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-33-1 name=__codelineno-33-1 href=#__codelineno-33-1></a><span class=cp>{%</span> <span class=k>html_attrs</span>
|
|
<a id=__codelineno-33-2 name=__codelineno-33-2 href=#__codelineno-33-2></a> <span class=nv>class</span><span class=o>=</span><span class=s2>"my-class other-class"</span>
|
|
<a id=__codelineno-33-3 name=__codelineno-33-3 href=#__codelineno-33-3></a> <span class=nv>class</span><span class=o>={</span><span class=s2>"extra-class"</span><span class=o>:</span> <span class=kp>True</span><span class=o>,</span> <span class=s2>"other-class"</span><span class=o>:</span> <span class=kp>False</span><span class=o>}</span>
|
|
<a id=__codelineno-33-4 name=__codelineno-33-4 href=#__codelineno-33-4></a><span class=cp>%}</span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-34-1 name=__codelineno-34-1 href=#__codelineno-34-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"my-class extra-class"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <h3 id=merging-style-attributes>Merging <code>style</code> attributes<a class=headerlink href=#merging-style-attributes title="Permanent link">¤</a></h3> <p>The <code>style</code> attribute can be specified as a string of style properties as usual.</p> <p>If you want granular control over individual style properties, you can use a dictionary.</p> <ul> <li> <p><strong>String</strong>: Used as is.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-35-1 name=__codelineno-35-1 href=#__codelineno-35-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>style</span><span class=o>=</span><span class=s2>"color: red; background-color: blue;"</span> <span class=cp>%}</span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-36-1 name=__codelineno-36-1 href=#__codelineno-36-1></a><span class=p><</span><span class=nt>div</span> <span class=na>style</span><span class=o>=</span><span class=s>"color: red; background-color: blue;"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Dictionary</strong>: Keys are the style properties, and values are their values.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-37-1 name=__codelineno-37-1 href=#__codelineno-37-1></a><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>style</span><span class=o>={</span>
|
|
<a id=__codelineno-37-2 name=__codelineno-37-2 href=#__codelineno-37-2></a> <span class=s2>"color"</span><span class=o>:</span> <span class=s2>"red"</span><span class=o>,</span>
|
|
<a id=__codelineno-37-3 name=__codelineno-37-3 href=#__codelineno-37-3></a> <span class=s2>"background-color"</span><span class=o>:</span> <span class=s2>"blue"</span><span class=o>,</span>
|
|
<a id=__codelineno-37-4 name=__codelineno-37-4 href=#__codelineno-37-4></a><span class=o>}</span> <span class=cp>%}</span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-38-1 name=__codelineno-38-1 href=#__codelineno-38-1></a><span class=p><</span><span class=nt>div</span> <span class=na>style</span><span class=o>=</span><span class=s>"color: red; background-color: blue;"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> </ul> <p>If a style property is specified multiple times, the last value is used.</p> <ul> <li>Properties set to <code>None</code> are ignored.</li> <li>If the last non-<code>None</code> instance of the property is set to <code>False</code>, the property is removed.</li> </ul> <p><strong>Example:</strong></p> <p>In this example, the <code>width</code> property is specified twice. The last instance is <code>{"width": False}</code>, so the property is removed.</p> <p>Secondly, the <code>background-color</code> property is also set twice. But the second time it's set to <code>None</code>, so that instance is ignored, leaving us only with <code>background-color: blue</code>.</p> <p>The <code>color</code> property is set to a valid value in both cases, so the latter (<code>green</code>) is used.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-39-1 name=__codelineno-39-1 href=#__codelineno-39-1></a><span class=cp>{%</span> <span class=k>html_attrs</span>
|
|
<a id=__codelineno-39-2 name=__codelineno-39-2 href=#__codelineno-39-2></a> <span class=nv>style</span><span class=o>=</span><span class=s2>"color: red; background-color: blue; width: 100px;"</span>
|
|
<a id=__codelineno-39-3 name=__codelineno-39-3 href=#__codelineno-39-3></a> <span class=nv>style</span><span class=o>={</span><span class=s2>"color"</span><span class=o>:</span> <span class=s2>"green"</span><span class=o>,</span> <span class=s2>"background-color"</span><span class=o>:</span> <span class=kp>None</span><span class=o>,</span> <span class=s2>"width"</span><span class=o>:</span> <span class=kp>False</span><span class=o>}</span>
|
|
<a id=__codelineno-39-4 name=__codelineno-39-4 href=#__codelineno-39-4></a><span class=cp>%}</span>
|
|
</code></pre></div> <p>Renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-40-1 name=__codelineno-40-1 href=#__codelineno-40-1></a><span class=p><</span><span class=nt>div</span> <span class=na>style</span><span class=o>=</span><span class=s>"color: green; background-color: blue;"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <h2 id=usage-outside-of-templates>Usage outside of templates<a class=headerlink href=#usage-outside-of-templates title="Permanent link">¤</a></h2> <p>In some cases, you want to prepare HTML attributes outside of templates.</p> <p>To achieve the same behavior as <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag, you can use the <a href=../../../reference/api#django_components.merge_attributes><code>merge_attributes()</code></a> and <a href=../../../reference/api#django_components.format_attributes><code>format_attributes()</code></a> helper functions.</p> <h3 id=merging-attributes>Merging attributes<a class=headerlink href=#merging-attributes title="Permanent link">¤</a></h3> <p><a href=../../../reference/api#django_components.merge_attributes><code>merge_attributes()</code></a> accepts any number of dictionaries and merges them together, using the same merge strategy as <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-41-1 name=__codelineno-41-1 href=#__codelineno-41-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components</span><span class=w> </span><span class=kn>import</span> <span class=n>merge_attributes</span>
|
|
<a id=__codelineno-41-2 name=__codelineno-41-2 href=#__codelineno-41-2></a>
|
|
<a id=__codelineno-41-3 name=__codelineno-41-3 href=#__codelineno-41-3></a><span class=n>merge_attributes</span><span class=p>(</span>
|
|
<a id=__codelineno-41-4 name=__codelineno-41-4 href=#__codelineno-41-4></a> <span class=p>{</span><span class=s2>"class"</span><span class=p>:</span> <span class=s2>"my-class"</span><span class=p>,</span> <span class=s2>"data-id"</span><span class=p>:</span> <span class=mi>123</span><span class=p>},</span>
|
|
<a id=__codelineno-41-5 name=__codelineno-41-5 href=#__codelineno-41-5></a> <span class=p>{</span><span class=s2>"class"</span><span class=p>:</span> <span class=s2>"extra-class"</span><span class=p>},</span>
|
|
<a id=__codelineno-41-6 name=__codelineno-41-6 href=#__codelineno-41-6></a> <span class=p>{</span><span class=s2>"class"</span><span class=p>:</span> <span class=p>{</span><span class=s2>"cool-class"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span> <span class=s2>"uncool-class"</span><span class=p>:</span> <span class=kc>False</span><span class=p>}</span> <span class=p>},</span>
|
|
<a id=__codelineno-41-7 name=__codelineno-41-7 href=#__codelineno-41-7></a><span class=p>)</span>
|
|
</code></pre></div> <p>Which will output:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-42-1 name=__codelineno-42-1 href=#__codelineno-42-1></a><span class=p>{</span>
|
|
<a id=__codelineno-42-2 name=__codelineno-42-2 href=#__codelineno-42-2></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"my-class extra-class cool-class"</span><span class=p>,</span>
|
|
<a id=__codelineno-42-3 name=__codelineno-42-3 href=#__codelineno-42-3></a> <span class=s2>"data-id"</span><span class=p>:</span> <span class=mi>123</span><span class=p>,</span>
|
|
<a id=__codelineno-42-4 name=__codelineno-42-4 href=#__codelineno-42-4></a><span class=p>}</span>
|
|
</code></pre></div> <div class="admonition warning"> <p class=admonition-title>Warning</p> <p>Unlike <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a>, where you can pass extra kwargs, <a href=../../../reference/api#django_components.merge_attributes><code>merge_attributes()</code></a> requires each argument to be a dictionary.</p> </div> <h3 id=formatting-attributes>Formatting attributes<a class=headerlink href=#formatting-attributes title="Permanent link">¤</a></h3> <p><a href=../../../reference/api#django_components.format_attributes><code>format_attributes()</code></a> serializes attributes the same way as <a href=../../../reference/template_tags#html_attrs><code>{% html_attrs %}</code></a> tag does.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-43-1 name=__codelineno-43-1 href=#__codelineno-43-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components</span><span class=w> </span><span class=kn>import</span> <span class=n>format_attributes</span>
|
|
<a id=__codelineno-43-2 name=__codelineno-43-2 href=#__codelineno-43-2></a>
|
|
<a id=__codelineno-43-3 name=__codelineno-43-3 href=#__codelineno-43-3></a><span class=n>format_attributes</span><span class=p>({</span>
|
|
<a id=__codelineno-43-4 name=__codelineno-43-4 href=#__codelineno-43-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-43-5 name=__codelineno-43-5 href=#__codelineno-43-5></a> <span class=s2>"data-id"</span><span class=p>:</span> <span class=mi>123</span><span class=p>,</span>
|
|
<a id=__codelineno-43-6 name=__codelineno-43-6 href=#__codelineno-43-6></a> <span class=s2>"required"</span><span class=p>:</span> <span class=kc>True</span><span class=p>,</span>
|
|
<a id=__codelineno-43-7 name=__codelineno-43-7 href=#__codelineno-43-7></a> <span class=s2>"disabled"</span><span class=p>:</span> <span class=kc>False</span><span class=p>,</span>
|
|
<a id=__codelineno-43-8 name=__codelineno-43-8 href=#__codelineno-43-8></a> <span class=s2>"ignored-attr"</span><span class=p>:</span> <span class=kc>None</span><span class=p>,</span>
|
|
<a id=__codelineno-43-9 name=__codelineno-43-9 href=#__codelineno-43-9></a><span class=p>})</span>
|
|
</code></pre></div> <p>Which will output:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-44-1 name=__codelineno-44-1 href=#__codelineno-44-1></a><span class=s1>'class="my-class text-red pa-4" data-id="123" required'</span>
|
|
</code></pre></div> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Prior to v0.135, the <code>format_attributes()</code> function was named <code>attributes_to_string()</code>.</p> <p>This function is now deprecated and will be removed in v1.0.</p> </div> <h2 id=cheat-sheet>Cheat sheet<a class=headerlink href=#cheat-sheet title="Permanent link">¤</a></h2> <p>Assuming that:</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>class_from_var</span> <span class=o>=</span> <span class=s2>"from-var"</span>
|
|
<a id=__codelineno-45-2 name=__codelineno-45-2 href=#__codelineno-45-2></a>
|
|
<a id=__codelineno-45-3 name=__codelineno-45-3 href=#__codelineno-45-3></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
|
<a id=__codelineno-45-4 name=__codelineno-45-4 href=#__codelineno-45-4></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"from-attrs"</span><span class=p>,</span>
|
|
<a id=__codelineno-45-5 name=__codelineno-45-5 href=#__codelineno-45-5></a> <span class=s2>"type"</span><span class=p>:</span> <span class=s2>"submit"</span><span class=p>,</span>
|
|
<a id=__codelineno-45-6 name=__codelineno-45-6 href=#__codelineno-45-6></a><span class=p>}</span>
|
|
<a id=__codelineno-45-7 name=__codelineno-45-7 href=#__codelineno-45-7></a>
|
|
<a id=__codelineno-45-8 name=__codelineno-45-8 href=#__codelineno-45-8></a><span class=n>defaults</span> <span class=o>=</span> <span class=p>{</span>
|
|
<a id=__codelineno-45-9 name=__codelineno-45-9 href=#__codelineno-45-9></a> <span class=s2>"class"</span><span class=p>:</span> <span class=s2>"from-defaults"</span><span class=p>,</span>
|
|
<a id=__codelineno-45-10 name=__codelineno-45-10 href=#__codelineno-45-10></a> <span class=s2>"role"</span><span class=p>:</span> <span class=s2>"button"</span><span class=p>,</span>
|
|
<a id=__codelineno-45-11 name=__codelineno-45-11 href=#__codelineno-45-11></a><span class=p>}</span>
|
|
</code></pre></div> <p>Then:</p> <ul> <li> <p><strong>Empty tag</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-46-1 name=__codelineno-46-1 href=#__codelineno-46-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders nothing:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-47-1 name=__codelineno-47-1 href=#__codelineno-47-1></a><span class=p><</span><span class=nt>div</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Only kwargs</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-48-1 name=__codelineno-48-1 href=#__codelineno-48-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"some-class"</span> <span class=nv>class</span><span class=o>=</span><span class=nv>class_from_var</span> <span class=nv>data-id</span><span class=o>=</span><span class=s2>"123"</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-49-1 name=__codelineno-49-1 href=#__codelineno-49-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"some-class from-var"</span> <span class=na>data-id</span><span class=o>=</span><span class=s>"123"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Only attrs</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-50-1 name=__codelineno-50-1 href=#__codelineno-50-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=nv>attrs</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-51-1 name=__codelineno-51-1 href=#__codelineno-51-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"from-attrs"</span> <span class=na>type</span><span class=o>=</span><span class=s>"submit"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Attrs as kwarg</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-52-1 name=__codelineno-52-1 href=#__codelineno-52-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=nv>attrs</span><span class=o>=</span><span class=nv>attrs</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-53-1 name=__codelineno-53-1 href=#__codelineno-53-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"from-attrs"</span> <span class=na>type</span><span class=o>=</span><span class=s>"submit"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Only defaults (as kwarg)</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-54-1 name=__codelineno-54-1 href=#__codelineno-54-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=nv>defaults</span><span class=o>=</span><span class=nv>defaults</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-55-1 name=__codelineno-55-1 href=#__codelineno-55-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"from-defaults"</span> <span class=na>role</span><span class=o>=</span><span class=s>"button"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Attrs using the <code>prefix:key=value</code> construct</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-56-1 name=__codelineno-56-1 href=#__codelineno-56-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=nv>attrs</span><span class=o>:</span><span class=nv>class</span><span class=o>=</span><span class=s2>"from-attrs"</span> <span class=nv>attrs</span><span class=o>:</span><span class=nv>type</span><span class=o>=</span><span class=s2>"submit"</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-57-1 name=__codelineno-57-1 href=#__codelineno-57-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"from-attrs"</span> <span class=na>type</span><span class=o>=</span><span class=s>"submit"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>Defaults using the <code>prefix:key=value</code> construct</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-58-1 name=__codelineno-58-1 href=#__codelineno-58-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attr</span> <span class=nv>defaults</span><span class=o>:</span><span class=nv>class</span><span class=o>=</span><span class=s2>"from-defaults"</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-59-1 name=__codelineno-59-1 href=#__codelineno-59-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"from-defaults"</span> <span class=na>role</span><span class=o>=</span><span class=s>"button"</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>All together (1) - attrs and defaults as positional args:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-60-1 name=__codelineno-60-1 href=#__codelineno-60-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=nv>class</span><span class=o>=</span><span class=s2>"added_class"</span> <span class=nv>class</span><span class=o>=</span><span class=nv>class_from_var</span> <span class=nv>data-id</span><span class=o>=</span><span class=m>123</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-61-1 name=__codelineno-61-1 href=#__codelineno-61-1></a><span class=p><</span><span class=nt>div</span> <span class=na>class</span><span class=o>=</span><span class=s>"from-attrs added_class from-var"</span> <span class=na>type</span><span class=o>=</span><span class=s>"submit"</span> <span class=na>role</span><span class=o>=</span><span class=s>"button"</span> <span class=na>data-id</span><span class=o>=</span><span class=s>123</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>All together (2) - attrs and defaults as kwargs args:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-62-1 name=__codelineno-62-1 href=#__codelineno-62-1></a><span class=x><div </span><span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"added_class"</span> <span class=nv>class</span><span class=o>=</span><span class=nv>class_from_var</span> <span class=nv>data-id</span><span class=o>=</span><span class=m>123</span> <span class=nv>attrs</span><span class=o>=</span><span class=nv>attrs</span> <span class=nv>defaults</span><span class=o>=</span><span class=nv>defaults</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</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>"from-attrs added_class from-var"</span> <span class=na>type</span><span class=o>=</span><span class=s>"submit"</span> <span class=na>role</span><span class=o>=</span><span class=s>"button"</span> <span class=na>data-id</span><span class=o>=</span><span class=s>123</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> <li> <p><strong>All together (3) - mixed:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-64-1 name=__codelineno-64-1 href=#__codelineno-64-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=o>:</span><span class=nv>class</span><span class=o>=</span><span class=s2>"default-class"</span> <span class=nv>class</span><span class=o>=</span><span class=s2>"added_class"</span> <span class=nv>class</span><span class=o>=</span><span class=nv>class_from_var</span> <span class=nv>data-id</span><span class=o>=</span><span class=m>123</span> <span class=cp>%}</span><span class=x>></div></span>
|
|
</code></pre></div> <p>renders:</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>"from-attrs added_class from-var"</span> <span class=na>type</span><span class=o>=</span><span class=s>"submit"</span> <span class=na>data-id</span><span class=o>=</span><span class=s>123</span><span class=p>></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> </li> </ul> <h2 id=full-example>Full example<a class=headerlink href=#full-example title="Permanent link">¤</a></h2> <div class=highlight><pre><span></span><code><a id=__codelineno-66-1 name=__codelineno-66-1 href=#__codelineno-66-1></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"my_comp"</span><span class=p>)</span>
|
|
<a id=__codelineno-66-2 name=__codelineno-66-2 href=#__codelineno-66-2></a><span class=k>class</span><span class=w> </span><span class=nc>MyComp</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
|
<a id=__codelineno-66-3 name=__codelineno-66-3 href=#__codelineno-66-3></a> <span class=nv>template</span><span class=p>:</span> <span class=nc>t.django_html</span> <span class=o>=</span> <span class=sd>"""</span>
|
|
<a id=__codelineno-66-4 name=__codelineno-66-4 href=#__codelineno-66-4></a> <span class=p><</span><span class=nt>div</span>
|
|
<a id=__codelineno-66-5 name=__codelineno-66-5 href=#__codelineno-66-5></a> <span class=cp>{%</span> <span class=k>html_attrs</span> <span class=nv>attrs</span>
|
|
<a id=__codelineno-66-6 name=__codelineno-66-6 href=#__codelineno-66-6></a> <span class=nv>defaults</span><span class=o>:</span><span class=nv>class</span><span class=o>=</span><span class=s2>"pa-4 text-red"</span>
|
|
<a id=__codelineno-66-7 name=__codelineno-66-7 href=#__codelineno-66-7></a> <span class=nv>class</span><span class=o>=</span><span class=s2>"my-comp-date"</span>
|
|
<a id=__codelineno-66-8 name=__codelineno-66-8 href=#__codelineno-66-8></a> <span class=nv>class</span><span class=o>=</span><span class=nv>class_from_var</span>
|
|
<a id=__codelineno-66-9 name=__codelineno-66-9 href=#__codelineno-66-9></a> <span class=nv>data-id</span><span class=o>=</span><span class=s2>"123"</span>
|
|
<a id=__codelineno-66-10 name=__codelineno-66-10 href=#__codelineno-66-10></a> <span class=cp>%}</span>
|
|
<a id=__codelineno-66-11 name=__codelineno-66-11 href=#__codelineno-66-11></a> <span class=p>></span>
|
|
<a id=__codelineno-66-12 name=__codelineno-66-12 href=#__codelineno-66-12></a> 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>
|
|
<a id=__codelineno-66-13 name=__codelineno-66-13 href=#__codelineno-66-13></a> <span class=p></</span><span class=nt>div</span><span class=p>></span>
|
|
<a id=__codelineno-66-14 name=__codelineno-66-14 href=#__codelineno-66-14></a> <span class=sd>"""</span>
|
|
<a id=__codelineno-66-15 name=__codelineno-66-15 href=#__codelineno-66-15></a>
|
|
<a id=__codelineno-66-16 name=__codelineno-66-16 href=#__codelineno-66-16></a> <span class=k>def</span><span class=w> </span><span class=nf>get_template_data</span><span class=p>(</span><span class=bp>self</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>context</span><span class=p>):</span>
|
|
<a id=__codelineno-66-17 name=__codelineno-66-17 href=#__codelineno-66-17></a> <span class=n>date</span> <span class=o>=</span> <span class=n>kwargs</span><span class=o>.</span><span class=n>pop</span><span class=p>(</span><span class=s2>"date"</span><span class=p>)</span>
|
|
<a id=__codelineno-66-18 name=__codelineno-66-18 href=#__codelineno-66-18></a> <span class=k>return</span> <span class=p>{</span>
|
|
<a id=__codelineno-66-19 name=__codelineno-66-19 href=#__codelineno-66-19></a> <span class=s2>"date"</span><span class=p>:</span> <span class=n>date</span><span class=p>,</span>
|
|
<a id=__codelineno-66-20 name=__codelineno-66-20 href=#__codelineno-66-20></a> <span class=s2>"attrs"</span><span class=p>:</span> <span class=n>kwargs</span><span class=p>,</span>
|
|
<a id=__codelineno-66-21 name=__codelineno-66-21 href=#__codelineno-66-21></a> <span class=s2>"class_from_var"</span><span class=p>:</span> <span class=s2>"extra-class"</span>
|
|
<a id=__codelineno-66-22 name=__codelineno-66-22 href=#__codelineno-66-22></a> <span class=p>}</span>
|
|
<a id=__codelineno-66-23 name=__codelineno-66-23 href=#__codelineno-66-23></a>
|
|
<a id=__codelineno-66-24 name=__codelineno-66-24 href=#__codelineno-66-24></a><span class=nd>@register</span><span class=p>(</span><span class=s2>"parent"</span><span class=p>)</span>
|
|
<a id=__codelineno-66-25 name=__codelineno-66-25 href=#__codelineno-66-25></a><span class=k>class</span><span class=w> </span><span class=nc>Parent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
|
|
<a id=__codelineno-66-26 name=__codelineno-66-26 href=#__codelineno-66-26></a> <span class=nv>template</span><span class=p>:</span> <span class=nc>t.django_html</span> <span class=o>=</span> <span class=sd>"""</span>
|
|
<a id=__codelineno-66-27 name=__codelineno-66-27 href=#__codelineno-66-27></a> <span class=cp>{%</span> <span class=k>component</span> <span class=s2>"my_comp"</span>
|
|
<a id=__codelineno-66-28 name=__codelineno-66-28 href=#__codelineno-66-28></a> <span class=nv>date</span><span class=o>=</span><span class=nv>date</span>
|
|
<a id=__codelineno-66-29 name=__codelineno-66-29 href=#__codelineno-66-29></a> <span class=nv>attrs</span><span class=o>:</span><span class=nv>class</span><span class=o>=</span><span class=s2>"pa-0 border-solid border-red"</span>
|
|
<a id=__codelineno-66-30 name=__codelineno-66-30 href=#__codelineno-66-30></a> <span class=nv>attrs</span><span class=o>:</span><span class=nv>data-json</span><span class=o>=</span><span class=nv>json_data</span>
|
|
<a id=__codelineno-66-31 name=__codelineno-66-31 href=#__codelineno-66-31></a> <span class=nv>attrs</span><span class=o>:</span><span class=p>@</span><span class=nv>click</span><span class=o>=</span><span class=s2>"(e) => onClick(e, 'from_parent')"</span>
|
|
<a id=__codelineno-66-32 name=__codelineno-66-32 href=#__codelineno-66-32></a> <span class=o>/</span> <span class=cp>%}</span>
|
|
<a id=__codelineno-66-33 name=__codelineno-66-33 href=#__codelineno-66-33></a> <span class=sd>"""</span>
|
|
<a id=__codelineno-66-34 name=__codelineno-66-34 href=#__codelineno-66-34></a>
|
|
<a id=__codelineno-66-35 name=__codelineno-66-35 href=#__codelineno-66-35></a> <span class=k>def</span><span class=w> </span><span class=nf>get_template_data</span><span class=p>(</span><span class=bp>self</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>context</span><span class=p>):</span>
|
|
<a id=__codelineno-66-36 name=__codelineno-66-36 href=#__codelineno-66-36></a> <span class=k>return</span> <span class=p>{</span>
|
|
<a id=__codelineno-66-37 name=__codelineno-66-37 href=#__codelineno-66-37></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-66-38 name=__codelineno-66-38 href=#__codelineno-66-38></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-66-39 name=__codelineno-66-39 href=#__codelineno-66-39></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> <div class=highlight><pre><span></span><code><a id=__codelineno-67-1 name=__codelineno-67-1 href=#__codelineno-67-1></a>defaults:class="pa-4 text-red"
|
|
</code></pre></div> <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-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>"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-69-1 name=__codelineno-69-1 href=#__codelineno-69-1></a><span class=x> attrs:class="pa-0 border-solid border-red"</span>
|
|
<a id=__codelineno-69-2 name=__codelineno-69-2 href=#__codelineno-69-2></a><span class=x> attrs:data-json=json_data</span>
|
|
<a id=__codelineno-69-3 name=__codelineno-69-3 href=#__codelineno-69-3></a><span class=x> attrs:@click="(e) => onClick(e, 'from_parent')"</span>
|
|
</code></pre></div> <p>And <code>get_template_data</code> of <code>MyComp</code> will receive a kwarg named <code>attrs</code> with following keys:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-70-1 name=__codelineno-70-1 href=#__codelineno-70-1></a><span class=n>attrs</span> <span class=o>=</span> <span class=p>{</span>
|
|
<a id=__codelineno-70-2 name=__codelineno-70-2 href=#__codelineno-70-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-70-3 name=__codelineno-70-3 href=#__codelineno-70-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-70-4 name=__codelineno-70-4 href=#__codelineno-70-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-70-5 name=__codelineno-70-5 href=#__codelineno-70-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-71-1 name=__codelineno-71-1 href=#__codelineno-71-1></a><span class=p><</span><span class=nt>div</span>
|
|
<a id=__codelineno-71-2 name=__codelineno-71-2 href=#__codelineno-71-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-71-3 name=__codelineno-71-3 href=#__codelineno-71-3></a> <span class=na>data-id</span><span class=o>=</span><span class=s>"123"</span>
|
|
<a id=__codelineno-71-4 name=__codelineno-71-4 href=#__codelineno-71-4></a> <span class=na>data-json</span><span class=o>=</span><span class=s>'{"value": 456}'</span>
|
|
<a id=__codelineno-71-5 name=__codelineno-71-5 href=#__codelineno-71-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-71-6 name=__codelineno-71-6 href=#__codelineno-71-6></a><span class=p>></span>
|
|
<a id=__codelineno-71-7 name=__codelineno-71-7 href=#__codelineno-71-7></a> ...
|
|
<a id=__codelineno-71-8 name=__codelineno-71-8 href=#__codelineno-71-8></a><span class=p></</span><span class=nt>div</span><span class=p>></span>
|
|
</code></pre></div> <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" title="May 3, 2025 10:04:10 UTC"><span class=timeago datetime=2025-05-03T10:04:10+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="May 3, 2025 10:04:10 UTC">2025-05-03</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=../template_tag_syntax/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Template tag syntax"> <div class="md-footer__button md-icon"> <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> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Template tag syntax </div> </div> </a> <a href=../component_views_urls/ class="md-footer__link md-footer__link--next" aria-label="Next: Component views and URLs"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Component views and URLs </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/django-components/django-components target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.0.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 2025 Fonticons, Inc.--><path fill=currentColor d="M173.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.9M252.8 8C114.1 8 8 113.3 8 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.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.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 7.0.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 2025 Fonticons, Inc.--><path fill=currentColor 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 444.7a20.4 20.4 0 1 1 0-40.7 20.4 20.4 0 1 1 0 40.7M167.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.6-183.4a20.4 20.4 0 1 1 0 40.8 20.4 20.4 0 1 1 0-40.8"/></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.tabs", "navigation.tracking", "navigation.top", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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.50899def.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> |