@govflanders/vl-widget-global-header-types 2.0.12 → 2.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -13
- package/docs/functions/bootstrap.html +1 -1
- package/docs/index.html +4 -4
- package/docs/interfaces/AccessMenuMethods.html +10 -10
- package/docs/interfaces/AlertConfig.html +4 -4
- package/docs/interfaces/Application.html +4 -4
- package/docs/interfaces/ApplicationMenuLink.html +5 -5
- package/docs/interfaces/Authorization.html +4 -4
- package/docs/interfaces/BUR.html +5 -5
- package/docs/interfaces/BaseEntity.html +4 -4
- package/docs/interfaces/BrandingConfigColors.html +3 -3
- package/docs/interfaces/BrandingConfigHost.html +5 -5
- package/docs/interfaces/BrandingConfigUmbrella.html +4 -4
- package/docs/interfaces/BrandingMethods.html +12 -12
- package/docs/interfaces/Channel.html +11 -11
- package/docs/interfaces/ContactMethods.html +8 -8
- package/docs/interfaces/ContactOption.html +15 -15
- package/docs/interfaces/ContactOptionRef.html +4 -4
- package/docs/interfaces/EA.html +4 -4
- package/docs/interfaces/EnrichedServicePoints.html +5 -5
- package/docs/interfaces/GID.html +4 -4
- package/docs/interfaces/GlobalHeaderClient.html +8 -8
- package/docs/interfaces/IDPData.html +4 -4
- package/docs/interfaces/Image.html +4 -4
- package/docs/interfaces/LB.html +4 -4
- package/docs/interfaces/Link.html +3 -3
- package/docs/interfaces/LinkWithTarget.html +4 -4
- package/docs/interfaces/MainLink.html +5 -5
- package/docs/interfaces/OV.html +4 -4
- package/docs/interfaces/ProfileConfig.html +7 -7
- package/docs/interfaces/ServicePoints.html +5 -5
- package/docs/interfaces/Session.html +2 -2
- package/docs/interfaces/User.html +3 -3
- package/docs/interfaces/VER.html +4 -4
- package/docs/types/AlertModifier.html +1 -1
- package/docs/types/BrandingConfigLevel.html +1 -1
- package/docs/types/CapacityCode.html +1 -1
- package/docs/types/ChannelIcon.html +1 -1
- package/docs/types/ChannelType.html +1 -1
- package/docs/types/CobrowseChannel.html +1 -1
- package/docs/types/ContactOptionSocialPlatform.html +1 -1
- package/docs/types/ContactServiceEndpoints.html +1 -1
- package/docs/types/EnrichedServicePoint.html +1 -1
- package/docs/types/Entity.html +1 -1
- package/docs/types/ServicePoint.html +1 -1
- package/package.json +1 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BrandingConfigHost | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="BrandingConfigHost.html">BrandingConfigHost</a></li></ul><h1>Interface BrandingConfigHost</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the host configuration shown to the right of the umbrella in the header (if an umbrella is available).</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BrandingConfigHost</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#href">href</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#label">label</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#logo">logo</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="Image.html" class="tsd-signature-type tsd-kind-interface">Image</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="10"><h4>Hierarchy (<a href="../hierarchy.html#BrandingConfigHost">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="LinkWithTarget.html" class="tsd-signature-type tsd-kind-interface">LinkWithTarget</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BrandingConfigHost</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BrandingConfigHost</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#href">href</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#label">label</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#logo">logo</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="Image.html" class="tsd-signature-type tsd-kind-interface">Image</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigHost.html#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="10"><h4>Hierarchy (<a href="../hierarchy.html#BrandingConfigHost">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="LinkWithTarget.html" class="tsd-signature-type tsd-kind-interface">LinkWithTarget</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BrandingConfigHost</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/branding.ts#lines-14">global-header-types/src/branding.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="BrandingConfigHost.html#href" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>href</span></a>
|
|
3
3
|
<a href="BrandingConfigHost.html#label" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label</span></a>
|
|
4
4
|
<a href="BrandingConfigHost.html#logo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logo</span></a>
|
|
5
5
|
<a href="BrandingConfigHost.html#target" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target?</span></a>
|
|
6
6
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="href" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>href</span><a href="#href" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The URL that the link will navigate to when clicked.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#href">href</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
8
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#label">label</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#href">href</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/link.ts#lines-13">global-header-types/src/link.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="label" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>label</span><a href="#label" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The text that will be displayed for the link.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#label">label</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/link.ts#lines-8">global-header-types/src/link.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="logo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>logo</span><a href="#logo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">logo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="Image.html" class="tsd-signature-type tsd-kind-interface">Image</a></div><div class="tsd-comment tsd-typography"><p>The logo image to display at the right of the host.
|
|
9
9
|
Can be an <code>Image</code> object or <code>null</code> if no logo is to be displayed.</p>
|
|
10
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/branding.ts#lines-19">global-header-types/src/branding.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="target" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>target</span><a href="#target" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Specifies where to open the linked document.
|
|
11
11
|
Can be:</p>
|
|
12
12
|
<ul>
|
|
13
13
|
<li><code>'_blank'</code>: Opens the link in a new tab or window.</li>
|
|
@@ -16,4 +16,4 @@ Can be:</p>
|
|
|
16
16
|
<li><code>'_top'</code>: Opens the link in the full body of the window.</li>
|
|
17
17
|
</ul>
|
|
18
18
|
<p>This property is optional and can be <code>null</code> if no target is specified.</p>
|
|
19
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#target">target</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
19
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#target">target</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/link.ts#lines-31">global-header-types/src/link.ts:31</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#href" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>href</span></a><a href="#label" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label</span></a><a href="#logo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logo</span></a><a href="#target" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Global Header</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BrandingConfigUmbrella | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="BrandingConfigUmbrella.html">BrandingConfigUmbrella</a></li></ul><h1>Interface BrandingConfigUmbrella</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the link shown on the top left in the header.
|
|
2
2
|
Only required for branding levels lower than 4.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BrandingConfigUmbrella</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BrandingConfigUmbrella.html#href">href</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigUmbrella.html#label">label</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigUmbrella.html#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="6"><h4>Hierarchy (<a href="../hierarchy.html#BrandingConfigUmbrella">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="LinkWithTarget.html" class="tsd-signature-type tsd-kind-interface">LinkWithTarget</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BrandingConfigUmbrella</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BrandingConfigUmbrella</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BrandingConfigUmbrella.html#href">href</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigUmbrella.html#label">label</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingConfigUmbrella.html#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="6"><h4>Hierarchy (<a href="../hierarchy.html#BrandingConfigUmbrella">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="LinkWithTarget.html" class="tsd-signature-type tsd-kind-interface">LinkWithTarget</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BrandingConfigUmbrella</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/branding.ts#lines-9">global-header-types/src/branding.ts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="BrandingConfigUmbrella.html#href" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>href</span></a>
|
|
4
4
|
<a href="BrandingConfigUmbrella.html#label" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label</span></a>
|
|
5
5
|
<a href="BrandingConfigUmbrella.html#target" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target?</span></a>
|
|
6
6
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="href" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>href</span><a href="#href" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The URL that the link will navigate to when clicked.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#href">href</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
8
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#label">label</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#href">href</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/link.ts#lines-13">global-header-types/src/link.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="label" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>label</span><a href="#label" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The text that will be displayed for the link.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#label">label</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/link.ts#lines-8">global-header-types/src/link.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="target" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>target</span><a href="#target" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Specifies where to open the linked document.
|
|
9
9
|
Can be:</p>
|
|
10
10
|
<ul>
|
|
11
11
|
<li><code>'_blank'</code>: Opens the link in a new tab or window.</li>
|
|
@@ -14,4 +14,4 @@ Can be:</p>
|
|
|
14
14
|
<li><code>'_top'</code>: Opens the link in the full body of the window.</li>
|
|
15
15
|
</ul>
|
|
16
16
|
<p>This property is optional and can be <code>null</code> if no target is specified.</p>
|
|
17
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#target">target</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="LinkWithTarget.html">LinkWithTarget</a>.<a href="LinkWithTarget.html#target">target</a></p><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/link.ts#lines-31">global-header-types/src/link.ts:31</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#href" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>href</span></a><a href="#label" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label</span></a><a href="#target" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Global Header</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BrandingMethods | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="BrandingMethods.html">BrandingMethods</a></li></ul><h1>Interface BrandingMethods</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BrandingMethods</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getcolor">getColor</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getcolors">getColors</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#gethost">getHost</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getlevel">getLevel</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getumbrella">getUmbrella</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getvariables">getVariables</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setcolor">setColor</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setcolors">setColors</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">colors</span><span class="tsd-signature-symbol">:</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#sethost">setHost</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setlevel">setLevel</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setumbrella">setUmbrella</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">umbrella</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/25d526db675889f3982b22a43efaeb34aff0bdd5/packages/global-header-types/src/client/branding.ts#lines-3">global-header-types/src/client/branding.ts:3</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="BrandingMethods.html#getcolor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Color</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BrandingMethods | Global Header</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Global Header</a></li><li><a href="BrandingMethods.html">BrandingMethods</a></li></ul><h1>Interface BrandingMethods</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BrandingMethods</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getcolor">getColor</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getcolors">getColors</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#gethost">getHost</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getlevel">getLevel</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getumbrella">getUmbrella</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#getvariables">getVariables</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setcolor">setColor</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setcolors">setColors</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">colors</span><span class="tsd-signature-symbol">:</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#sethost">setHost</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setlevel">setLevel</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BrandingMethods.html#setumbrella">setUmbrella</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">umbrella</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-3">global-header-types/src/client/branding.ts:3</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="BrandingMethods.html#getcolor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Color</span></a>
|
|
2
2
|
<a href="BrandingMethods.html#getcolors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Colors</span></a>
|
|
3
3
|
<a href="BrandingMethods.html#gethost" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Host</span></a>
|
|
4
4
|
<a href="BrandingMethods.html#getlevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Level</span></a>
|
|
@@ -15,59 +15,59 @@
|
|
|
15
15
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">color</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">getColor</span><span class="hl-2">(</span><span class="hl-11">'primary'</span><span class="hl-2">);</span>
|
|
16
16
|
</code><button type="button">Copy</button></pre>
|
|
17
17
|
|
|
18
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
18
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-36">global-header-types/src/client/branding.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getcolors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Colors</span><a href="#getcolors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getColors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the branding colors</p>
|
|
19
19
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getcolors__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">></span></h4><p>The branding colors</p>
|
|
20
20
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-1" class="tsd-anchor"></a>Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">colors</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">getColors</span><span class="hl-2">();</span>
|
|
21
21
|
</code><button type="button">Copy</button></pre>
|
|
22
22
|
|
|
23
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
23
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-27">global-header-types/src/client/branding.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="gethost" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Host</span><a href="#gethost" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getHost</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the branding host configuration</p>
|
|
24
24
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="gethost__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The branding host configuration</p>
|
|
25
25
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-2" class="tsd-anchor"></a>Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">hostConfig</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">getHost</span><span class="hl-2">();</span>
|
|
26
26
|
</code><button type="button">Copy</button></pre>
|
|
27
27
|
|
|
28
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
28
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-62">global-header-types/src/client/branding.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getlevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Level</span><a href="#getlevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getLevel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the branding level</p>
|
|
29
29
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getlevel__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The branding level</p>
|
|
30
30
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-3" class="tsd-anchor"></a>Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">level</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">getLevel</span><span class="hl-2">();</span>
|
|
31
31
|
</code><button type="button">Copy</button></pre>
|
|
32
32
|
|
|
33
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
33
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-10">global-header-types/src/client/branding.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getumbrella" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Umbrella</span><a href="#getumbrella" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getUmbrella</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the branding umbrella configuration</p>
|
|
34
34
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getumbrella__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The branding umbrella configuration</p>
|
|
35
35
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-4" class="tsd-anchor"></a>Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">umbrellaConfig</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">getUmbrella</span><span class="hl-2">();</span>
|
|
36
36
|
</code><button type="button">Copy</button></pre>
|
|
37
37
|
|
|
38
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
38
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-79">global-header-types/src/client/branding.ts:79</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getvariables" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Variables</span><a href="#getvariables" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getVariables</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get the branding variables</p>
|
|
39
39
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getvariables__type-1"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>A record of CSS variable names and their values</p>
|
|
40
40
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-5" class="tsd-anchor"></a>Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">variables</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">getVariables</span><span class="hl-2">();</span>
|
|
41
41
|
</code><button type="button">Copy</button></pre>
|
|
42
42
|
|
|
43
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
43
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-96">global-header-types/src/client/branding.ts:96</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setcolor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Color</span><a href="#setcolor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setColor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set a specific branding color</p>
|
|
44
44
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setcolor__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>The branding color type and value to set</p>
|
|
45
45
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A boolean indicating the success of the operation</p>
|
|
46
46
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-6" class="tsd-anchor"></a>Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">setColor</span><span class="hl-2">({ </span><span class="hl-7">type:</span><span class="hl-2"> </span><span class="hl-11">'primary'</span><span class="hl-2">, </span><span class="hl-7">value:</span><span class="hl-2"> </span><span class="hl-11">'#FF0000'</span><span class="hl-2"> });</span>
|
|
47
47
|
</code><button type="button">Copy</button></pre>
|
|
48
48
|
|
|
49
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
49
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-54">global-header-types/src/client/branding.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setcolors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Colors</span><a href="#setcolors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setColors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">colors</span><span class="tsd-signature-symbol">:</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the branding colors</p>
|
|
50
50
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setcolors__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">colors</span><span class="tsd-signature-symbol">:</span> <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">colors</span>: <a href="BrandingConfigColors.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigColors</a></span><div class="tsd-comment tsd-typography"><p>The branding colors to set</p>
|
|
51
51
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A boolean indicating the success of the operation</p>
|
|
52
52
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-7" class="tsd-anchor"></a>Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">setColors</span><span class="hl-2">({ </span><span class="hl-7">primary:</span><span class="hl-2"> </span><span class="hl-11">'#000000'</span><span class="hl-2">, </span><span class="hl-7">functional:</span><span class="hl-2"> </span><span class="hl-11">'#FFFFFF'</span><span class="hl-2"> });</span>
|
|
53
53
|
</code><button type="button">Copy</button></pre>
|
|
54
54
|
|
|
55
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
55
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-45">global-header-types/src/client/branding.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sethost" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Host</span><a href="#sethost" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setHost</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the branding host configuration</p>
|
|
56
56
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="sethost__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">host</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigHost.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigHost</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The branding host configuration to set</p>
|
|
57
57
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A boolean indicating the success of the operation</p>
|
|
58
58
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-8" class="tsd-anchor"></a>Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">setHost</span><span class="hl-2">({ </span><span class="hl-7">label:</span><span class="hl-2"> </span><span class="hl-11">'My Host'</span><span class="hl-2">, </span><span class="hl-7">href:</span><span class="hl-2"> </span><span class="hl-11">'https://example.com'</span><span class="hl-2">, </span><span class="hl-7">logo:</span><span class="hl-2"> { </span><span class="hl-7">src:</span><span class="hl-2"> </span><span class="hl-11">'logo.png'</span><span class="hl-2">, </span><span class="hl-7">alt:</span><span class="hl-2"> </span><span class="hl-11">'Logo'</span><span class="hl-2"> } });</span>
|
|
59
59
|
</code><button type="button">Copy</button></pre>
|
|
60
60
|
|
|
61
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
61
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-71">global-header-types/src/client/branding.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setlevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Level</span><a href="#setlevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setLevel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the branding level</p>
|
|
62
62
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setlevel__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The branding level to set</p>
|
|
63
63
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A boolean indicating the success of the operation</p>
|
|
64
64
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-9" class="tsd-anchor"></a>Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">setLevel</span><span class="hl-2">(</span><span class="hl-14">2</span><span class="hl-2">);</span>
|
|
65
65
|
</code><button type="button">Copy</button></pre>
|
|
66
66
|
|
|
67
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
67
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-19">global-header-types/src/client/branding.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setumbrella" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Umbrella</span><a href="#setumbrella" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setUmbrella</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">umbrella</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Set the branding umbrella configuration</p>
|
|
68
68
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setumbrella__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">umbrella</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">umbrella</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="BrandingConfigUmbrella.html" class="tsd-signature-type tsd-kind-interface">BrandingConfigUmbrella</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The branding umbrella configuration to set</p>
|
|
69
69
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A boolean indicating the success of the operation</p>
|
|
70
70
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-10" class="tsd-anchor"></a>Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">success</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">globalHeaderClient</span><span class="hl-2">.</span><span class="hl-7">branding</span><span class="hl-2">.</span><span class="hl-8">setUmbrella</span><span class="hl-2">({ </span><span class="hl-7">label:</span><span class="hl-2"> </span><span class="hl-11">'Umbrella'</span><span class="hl-2">, </span><span class="hl-7">href:</span><span class="hl-2"> </span><span class="hl-11">'https://umbrella.com'</span><span class="hl-2"> });</span>
|
|
71
71
|
</code><button type="button">Copy</button></pre>
|
|
72
72
|
|
|
73
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
73
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/48965323497ccc5694121a088bb47a486d721aa4/packages/global-header-types/src/client/branding.ts#lines-88">global-header-types/src/client/branding.ts:88</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#getcolor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Color</span></a><a href="#getcolors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Colors</span></a><a href="#gethost" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Host</span></a><a href="#getlevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Level</span></a><a href="#getumbrella" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Umbrella</span></a><a href="#getvariables" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Variables</span></a><a href="#setcolor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Color</span></a><a href="#setcolors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Colors</span></a><a href="#sethost" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Host</span></a><a href="#setlevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Level</span></a><a href="#setumbrella" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Umbrella</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Global Header</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|