<!DOCTYPE html><htmlclass="default"lang="en"data-base="../"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>default | trilium</title><metaname="description"content="Documentation for trilium"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-script"></script><scriptasyncsrc="../assets/hierarchy.js"id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os";document.body.style.display="none";setTimeout(()=>window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><ahref="../index.html"class="title">trilium</a><divid="tsd-toolbar-links"></div><buttonid="tsd-search-trigger"class="tsd-widget"aria-label="Search"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-search"></use></svg></button><dialogid="tsd-search"aria-label="Search"><inputrole="combobox"id="tsd-search-input"aria-controls="tsd-search-results"aria-autocomplete="list"aria-expanded="true"autocapitalize="off"autocomplete="off"placeholder="Search the docs"maxLength="100"/><ulrole="listbox"id="tsd-search-results"></ul><divid="tsd-search-status"aria-live="polite"aria-atomic="true"><div>Preparing search index...</div></div></dialog><ahref="#"class="tsd-widget menu"id="tsd-toolbar-menu-trigger"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"aria-label="Breadcrumb"><li><ahref="../modules/Frontend_Script_API.html">Frontend Script API</a></li><li><ahref="../modules/Frontend_Script_API._internal_.html"><internal></a></li><li><ahref=""aria-current="page">default</a></li></ul><h1>Class default</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>This is the base widget for all other widgets.</p>
<p>For information on using widgets, see the tutorial {@tutorial widget_basics}.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>the name of the CSS attribute to set (e.g. <code>padding-left</code>).</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>the value of the CSS attribute to set (e.g. <code>12px</code>).</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref=""class="tsd-signature-type tsd-kind-class">default</a></h4><p>self for chaining.</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from TypedBasicWidget.css</p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84883a6e267a4cfd7d26a14ec43a31d53c76e99b/src/public/app/widgets/basic_widget.ts#L76">src/public/app/widgets/basic_widget.ts:76</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="cssblock"><span>css<wbr/>Block</span><ahref="#cssblock"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-is-inherited"><divclass="tsd-signature tsd-anchor-link"id="cssblock-1"><spanclass="tsd-kind-call-signature">cssBlock</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">block</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref=""class="tsd-signature-type tsd-kind-class">default</a><ahref="#cssblock-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Accepts a string of CSS to add with the widget.</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from TypedBasicWidget.cssBlock</p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84883a6e267a4cfd7d26a14ec43a31d53c76e99b/src/public/app/widgets/basic_widget.ts#L118">src/public/app/widgets/basic_widget.ts:118</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="dorender"><span>do<wbr/>Render</span><ahref="#dorender"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-is-inherited"><divclass="tsd-signature tsd-anchor-link"id="dorender-1"><spanclass="tsd-kind-call-signature">doRender</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#dorender-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Method used for rendering the widget.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">boolean</span></h4><p>whether the widget is enabled.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">condition</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>whether to add the components.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">components</span>: <ahref="Frontend_Script_API._internal_.default-2.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>the components to be added as children to this component provided the condition is truthy.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref=""class="tsd-signature-type tsd-kind-class">default</a></h4><p>self for chaining.</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from TypedBasicWidget.optChild</p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84883a6e267a4cfd7d26a14ec43a31d53c76e99b/src/public/app/widgets/basic_widget.ts#L51">src/public/app/widgets/basic_widget.ts:51</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="optcss"><span>opt<wbr/>Css</span><ahref="#optcss"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-is-inherited"><divclass="tsd-signature tsd-anchor-link"id="optcss-1"><spanclass="tsd-kind-call-signature">optCss</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">condition</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">name</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref=""class="tsd-signature-type tsd-kind-class">default</a><ahref="#optcss-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">condition</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p><code>true</code> in order to apply the CSS, <code>false</code> to ignore it.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>the name of the CSS attribute to set (e.g. <code>padding-left</code>).</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>the value of the CSS attribute to set (e.g. <code>12px</code>).</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref=""class="tsd-signature-type tsd-kind-class">default</a></h4><p>self for chaining.</p>
