@govflanders/vl-widget-global-header-types 1.0.41 → 2.0.2
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 +102 -50
- package/dist/idp.d.ts +43 -8
- package/docs/assets/highlight.css +8 -8
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +59 -33
- 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 +7 -7
- package/docs/interfaces/BUR.html +5 -5
- package/docs/interfaces/BaseEntity.html +5 -5
- package/docs/interfaces/BrandingConfigColors.html +3 -3
- package/docs/interfaces/BrandingConfigHost.html +5 -5
- package/docs/interfaces/BrandingConfigUmbrella.html +4 -4
- package/docs/interfaces/Channel.html +11 -11
- package/docs/interfaces/ContactOption.html +14 -14
- 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 +9 -9
- package/docs/interfaces/IDPData.html +6 -4
- package/docs/interfaces/Image.html +4 -4
- package/docs/interfaces/LB.html +12 -0
- 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 +8 -0
- 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 +5 -5
- package/docs/modules.html +2 -0
- 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 +2 -2
- package/docs/types/ServicePoint.html +1 -1
- package/docs/types/Translatable.html +1 -1
- package/package.json +1 -1
package/docs/index.html
CHANGED
|
@@ -1,37 +1,29 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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><link rel="stylesheet" href="assets/typedoc-github-style.css"/></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" data-base="."><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"><h1>Global Header</h1></div><div class="tsd-panel tsd-typography"><
|
|
2
|
-
<
|
|
3
|
-
<
|
|
4
|
-
<a id="md:using-the-
|
|
5
|
-
<p>Example of using the
|
|
6
|
-
<pre><code class="html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-2"> </span><span class="hl-3">lang</span><span class="hl-2">=</span><span class="hl-4">"nl"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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><link rel="stylesheet" href="assets/typedoc-github-style.css"/></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" data-base="."><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"><h1>Global Header</h1></div><div class="tsd-panel tsd-typography"><a id="md:introduction" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Introduction<a href="#md:introduction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This guide is for developers looking to integrate the Flanders Global Header into their websites.</p>
|
|
2
|
+
<a id="md:adding-a-flanders-global-header-to-your-website" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Adding a Flanders Global Header to Your Website<a href="#md:adding-a-flanders-global-header-to-your-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can integrate the <strong>Flanders Global Header</strong> into your website using one of two methods: the <strong>entry script</strong> or the <strong>embed script</strong>. Each serves a different purpose.</p>
|
|
3
|
+
<p>💡 Note: the embed url differs from the previous one. Now it's <code>api/v2</code> instead of <code>api/v1</code>.</p>
|
|
4
|
+
<a id="md:using-the-embed-script-automatic-mounting" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the Embed Script (Automatic Mounting)<a href="#md:using-the-embed-script-automatic-mounting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Use the embed script for quick and automatic integration with minimal setup. The embed script is meant to be placed directly inside the DOM where you want the header to appear. It automatically renders the header at the script's location in the HTML.</p>
|
|
5
|
+
<p>Example of using the embed script:</p>
|
|
6
|
+
<pre><code class="html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-2"> </span><span class="hl-3">lang</span><span class="hl-2">=</span><span class="hl-4">"nl"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"UTF-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1.0"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">Global header embed script example</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/9717ae3b-84e8-43b2-a814-e35a2547927f/embed"</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-2"> </span><span class="hl-3">class</span><span class="hl-2">=</span><span class="hl-4">"your-website-code"</span><span class="hl-0">></span><span class="hl-2">👋 Hello world</span><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">html</span><span class="hl-0">></span>
|
|
7
7
|
</code><button type="button">Copy</button></pre>
|
|
8
8
|
|
|
9
|
-
<
|
|
10
|
-
<p>
|
|
11
|
-
<
|
|
9
|
+
<p>⚠️ Warning: the <code>window.globalHeaderClient</code> object will only be available after the scrip is resolved. If it's necessary to have direct access to the <code>window.globalHeaderClient</code>, use the entry script.</p>
|
|
10
|
+
<a id="md:using-the-entry-script-manual-mounting" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the Entry Script (Manual Mounting)<a href="#md:using-the-entry-script-manual-mounting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Use the entry script if you need more control over when, where and how the header is mounted. The entry script should be placed in the <code><head></code> section of your HTML, preferably at the top. This is essential because the <code>window.globalHeaderClient</code> object is only available after this script has loaded. With the entry script, the header does not render automatically, so you'll need to call the <code>mount</code> method to display it.</p>
|
|
11
|
+
<p>Example of using the entry script:</p>
|
|
12
|
+
<pre><code class="html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-2"> </span><span class="hl-3">lang</span><span class="hl-2">=</span><span class="hl-4">"nl"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/9717ae3b-84e8-43b2-a814-e35a2547927f/entry"</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"UTF-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1.0"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">Global header entry script example</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-2"> </span><span class="hl-3">class</span><span class="hl-2">=</span><span class="hl-4">"your-website-code"</span><span class="hl-0">></span><span class="hl-2">👋 Hello world</span><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-6">window</span><span class="hl-5">.</span><span class="hl-6">globalHeaderClient</span><span class="hl-5">.</span><span class="hl-7">mount</span><span class="hl-5">(); </span><span class="hl-8">// Mount the header manually after the script has loaded</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">html</span><span class="hl-0">></span>
|
|
12
13
|
</code><button type="button">Copy</button></pre>
|
|
13
14
|
|
|
14
15
|
<a id="md:summary" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Summary<a href="#md:summary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
15
|
-
<li><strong>Entry script</strong>: Use in the <code><head></code>, requires manual mounting with <
|
|
16
|
+
<li><strong>Entry script</strong>: Use in the <code><head></code>, requires manual mounting with <code>window.globalHeaderClient.mount()</code> method.</li>
|
|
16
17
|
<li><strong>Embed script</strong>: Place directly in the DOM, automatically renders the header at the script's location.</li>
|
|
17
18
|
</ul>
|
|
18
|
-
<a id="md:
|
|
19
|
-
<
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
<p>or</p>
|
|
23
|
-
<pre><code class="bash"><span class="hl-7">yarn</span><span class="hl-2"> </span><span class="hl-9">add</span><span class="hl-2"> </span><span class="hl-10">-D</span><span class="hl-2"> </span><span class="hl-9">@govflanders/vl-widget-global-header-types</span>
|
|
24
|
-
</code><button type="button">Copy</button></pre>
|
|
25
|
-
|
|
26
|
-
<p><strong>Note:</strong> It’s recommended to use the caret (^) symbol in your package.json to stay updated with the latest minor and patch versions.</p>
|
|
27
|
-
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This package provides all the types required for working with the Global Header Widget. The widget is available on the global window object as <code>window.globalHeaderClient</code>. You can import the types from global-header-types to use them in your project.</p>
|
|
28
|
-
<p>Example of using the types to interact with the widget:</p>
|
|
29
|
-
<pre><code class="typescript"><span class="hl-11">import</span><span class="hl-2"> { </span><span class="hl-6">GlobalHeaderClient</span><span class="hl-2">, </span><span class="hl-6">MainLink</span><span class="hl-2"> } </span><span class="hl-11">from</span><span class="hl-2"> </span><span class="hl-9">'@govflanders/vl-widget-global-header-types'</span><span class="hl-2">;</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">client</span><span class="hl-2">: </span><span class="hl-13">GlobalHeaderClient</span><span class="hl-2"> = </span><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">globalHeaderClient</span><span class="hl-2">;</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">contactLink</span><span class="hl-2">: </span><span class="hl-13">MainLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Contact'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'/contact'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">feedbackLink</span><span class="hl-2">: </span><span class="hl-13">MainLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://example.com/feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">isExternal:</span><span class="hl-2"> </span><span class="hl-10">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">target:</span><span class="hl-2"> </span><span class="hl-9">'_blank'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-6">client</span><span class="hl-2">.</span><span class="hl-7">setMainLinks</span><span class="hl-2">([</span><br/><span class="hl-2"> </span><span class="hl-6">contactLink</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">feedbackLink</span><span class="hl-2">,</span><br/><span class="hl-2">]);</span>
|
|
19
|
+
<a id="md:using-the-windowglobalheaderclient-api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Using the <code>window.globalHeaderClient</code> API<a href="#md:using-the-windowglobalheaderclient-api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The widget is available on the global window object as <code>window.globalHeaderClient</code>. You can import the types from global-header-types to use them in your project, if you're using typescript (more info <a href="#md:typescript-support">here</a>).</p>
|
|
20
|
+
<p>Example of using the <code>window.globalHeaderClient</code> object in javascript:</p>
|
|
21
|
+
<pre><code class="javascript"><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">client</span><span class="hl-2"> = </span><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">globalHeaderClient</span><span class="hl-2">;</span><br/><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">contactLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-11">'Contact'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-11">'/contact'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">feedbackLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-11">'Feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-11">'https://example.com/feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">isExternal:</span><span class="hl-2"> </span><span class="hl-9">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">target:</span><span class="hl-2"> </span><span class="hl-11">'_blank'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-6">client</span><span class="hl-2">.</span><span class="hl-6">accessMenu</span><span class="hl-2">.</span><span class="hl-7">setMainLinks</span><span class="hl-2">([</span><br/><span class="hl-2"> </span><span class="hl-6">contactLink</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">feedbackLink</span><span class="hl-2">,</span><br/><span class="hl-2">]);</span>
|
|
30
22
|
</code><button type="button">Copy</button></pre>
|
|
31
23
|
|
|
32
24
|
<p>Checkout the <a href="./interfaces/GlobalHeaderClient.html">GlobalHeaderClient</a> here to see all the available methods.</p>
|
|
33
25
|
<a id="md:migration-guide-upgrading-from-v4-to-v5" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Migration guide: Upgrading from v4 to v5<a href="#md:migration-guide-upgrading-from-v4-to-v5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>If you’re currently using version 4 of the Global Header Widget, please follow this guide to upgrade to version 5. This guide highlights the key changes and steps you need to take to ensure a smooth transition.</p>
|
|
34
|
-
<a id="md:remove-client-library-script-links" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Remove client library script links<a href="#md:remove-client-library-script-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>No more client library or polyfill scripts: In version 5, you no longer need to include any additional client library or polyfill script links in your HTML. Access to the <code>window.globalHeaderClient</code> object is automatically provided when you include either the entry script or the embed script.
|
|
26
|
+
<a id="md:remove-client-library-script-links" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Remove client library script links<a href="#md:remove-client-library-script-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>No more client library or polyfill scripts: In version 5, you no longer need to include any additional client library or polyfill script links in your HTML. Access to the <code>window.globalHeaderClient</code> object is automatically provided when you include either the entry script or the embed script (after the script is loaded).
|
|
35
27
|
Action Required:</p>
|
|
36
28
|
<ul>
|
|
37
29
|
<li>Remove any <code><script></code> tags that reference client libraries or polyfill libraries for the widget.</li>
|
|
@@ -44,11 +36,11 @@ Action Required:</p>
|
|
|
44
36
|
<li>Delete any import or require statements in your JavaScript code that reference the widget.</li>
|
|
45
37
|
</ul>
|
|
46
38
|
<a id="md:update-embed-script-links" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Update Embed script links<a href="#md:update-embed-script-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Version Update in Embed Links: If you’re using the embed script method to include the widget, you need to update the version number in your script’s src URL from 'v1' to 'v2'. <a href="#md:adding-a-flanders-global-header-to-your-website">Example here</a>.</p>
|
|
47
|
-
<a id="md:update-api-usage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Update API usage<a href="#md:update-api-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>API Changes: The globalHeaderClient API has been updated in version 5. Methods, their signatures, and usage patterns may have changed. Refer to the <a href="
|
|
39
|
+
<a id="md:update-api-usage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Update API usage<a href="#md:update-api-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>API Changes: The <code>window.globalHeaderClient</code> API has been updated in version 5. Methods, their signatures, and usage patterns may have changed. Refer to the <a href="./interfaces/GlobalHeaderClient.html">GlobalHeaderClient</a> section for detailed information on the new methods and their parameters.</p>
|
|
48
40
|
<p>Action Required:</p>
|
|
49
41
|
<ul>
|
|
50
|
-
<li>Review all instances where you interact with globalHeaderClient
|
|
51
|
-
<li>Update your code to align with the new <a href="
|
|
42
|
+
<li>Review all instances where you interact with <code>window.globalHeaderClient</code>.</li>
|
|
43
|
+
<li>Update your code to align with the new <a href="./interfaces/GlobalHeaderClient.html">GlobalHeaderClient</a> methods and their signatures.</li>
|
|
52
44
|
<li>Pay special attention to asynchronous methods that now return promises.</li>
|
|
53
45
|
</ul>
|
|
54
46
|
<p>Example:</p>
|
|
@@ -79,7 +71,7 @@ Action Required:</p>
|
|
|
79
71
|
<li>Adjust Styles if Needed: Modify your CSS or override styles to resolve any layout or design issues.</li>
|
|
80
72
|
<li>Seek Assistance: If problems persist, don’t hesitate to <a href="#md:contact-information">contact us</a> for support.</li>
|
|
81
73
|
</ul>
|
|
82
|
-
<a id="md:language-switching" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Language Switching<a href="#md:language-switching" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The widget automatically adapts to the language of the document. It observes the <code>lang</code> attribute on the <code><html></code> tag, so it's the implementer's responsibility to handle any language switching functionality. If the <code>lang</code> attribute changes, the widget will update to display the correct language.</p>
|
|
74
|
+
<a id="md:language-switching" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Language Switching<a href="#md:language-switching" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <strong>Global Header Widget</strong> v5 now supports multiple languages. The widget automatically adapts to the language of the document. It observes the <code>lang</code> attribute on the <code><html></code> tag, so it's the implementer's responsibility to handle any language switching functionality. If the <code>lang</code> attribute changes, the widget will update to display the correct language.</p>
|
|
83
75
|
<p>Supported languages:</p>
|
|
84
76
|
<ul>
|
|
85
77
|
<li>nl (Dutch)</li>
|
|
@@ -88,11 +80,16 @@ Action Required:</p>
|
|
|
88
80
|
<li>en (English)</li>
|
|
89
81
|
</ul>
|
|
90
82
|
<p>To change the document language, you can use the following JavaScript snippet:</p>
|
|
91
|
-
<pre><code class="js"><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">document</span><span class="hl-2">.</span><span class="hl-6">documentElement</span><span class="hl-2">.</span><span class="hl-6">lang</span><span class="hl-2"> = </span><span class="hl-
|
|
83
|
+
<pre><code class="js"><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">document</span><span class="hl-2">.</span><span class="hl-6">documentElement</span><span class="hl-2">.</span><span class="hl-6">lang</span><span class="hl-2"> = </span><span class="hl-11">'nl'</span><span class="hl-2">; </span><span class="hl-8">// 'nl', 'en', 'de' or 'fr'</span>
|
|
92
84
|
</code><button type="button">Copy</button></pre>
|
|
93
85
|
|
|
94
86
|
<p>This will switch the document's language to Dutch, and the widget will automatically reflect the change.</p>
|
|
95
|
-
<p>
|
|
87
|
+
<p>Notes:</p>
|
|
88
|
+
<ul>
|
|
89
|
+
<li>When using a multilingual widget, ensure its configuration also supports multiple languages.</li>
|
|
90
|
+
<li>Lang tag variants are also handled correctly (for example, like <code>NL</code> or <code>nl-BE</code>)</li>
|
|
91
|
+
<li>Take a look at the documentation for multilingual objects <a href="./types/Translatable.html">here</a>.</li>
|
|
92
|
+
</ul>
|
|
96
93
|
<a id="md:browser-support" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Browser Support<a href="#md:browser-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <strong>Global Header Widget</strong> supports the two most recent versions of all major browsers:</p>
|
|
97
94
|
<ul>
|
|
98
95
|
<li>Google Chrome</li>
|
|
@@ -101,12 +98,41 @@ Action Required:</p>
|
|
|
101
98
|
<li>Safari</li>
|
|
102
99
|
</ul>
|
|
103
100
|
<p>Please ensure your users are on the latest versions of these browsers to guarantee full functionality of the widget.</p>
|
|
101
|
+
<a id="md:typescript-support" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Typescript Support<a href="#md:typescript-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <strong><code>@govflanders/vl-widget-global-header-types</code></strong> package provides TypeScript types and interfaces for interacting with the <strong>Global Header Widget</strong>. This widget is embedded in customer web pages and exposes a client object (<code>window.globalHeaderClient</code>) that allows for dynamic configuration and interaction with the global header.</p>
|
|
102
|
+
<p>By using the types defined in this package, developers can ensure type-safe interactions with the widget while improving their development experience (DX) by utilizing autocompletion and built-in documentation.</p>
|
|
103
|
+
<a id="md:installation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>To install the <code>global-header-types</code> package, use the following command:</p>
|
|
104
|
+
<pre><code class="bash"><span class="hl-7">npm</span><span class="hl-2"> </span><span class="hl-11">install</span><span class="hl-2"> </span><span class="hl-9">-D</span><span class="hl-2"> </span><span class="hl-11">@govflanders/vl-widget-global-header-types</span>
|
|
105
|
+
</code><button type="button">Copy</button></pre>
|
|
106
|
+
|
|
107
|
+
<p>or</p>
|
|
108
|
+
<pre><code class="bash"><span class="hl-7">yarn</span><span class="hl-2"> </span><span class="hl-11">add</span><span class="hl-2"> </span><span class="hl-9">-D</span><span class="hl-2"> </span><span class="hl-11">@govflanders/vl-widget-global-header-types</span>
|
|
109
|
+
</code><button type="button">Copy</button></pre>
|
|
110
|
+
|
|
111
|
+
<p><strong>Note:</strong> It’s recommended to use the caret (^) symbol in your package.json to stay updated with the latest minor and patch versions.</p>
|
|
112
|
+
<a id="md:usage-example" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Usage example<a href="#md:usage-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Example of using the types to interact with the widget:</p>
|
|
113
|
+
<pre><code class="typescript"><span class="hl-12">import</span><span class="hl-2"> { </span><span class="hl-6">GlobalHeaderClient</span><span class="hl-2">, </span><span class="hl-6">MainLink</span><span class="hl-2"> } </span><span class="hl-12">from</span><span class="hl-2"> </span><span class="hl-11">'@govflanders/vl-widget-global-header-types'</span><span class="hl-2">;</span><br/><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">client</span><span class="hl-2">: </span><span class="hl-13">GlobalHeaderClient</span><span class="hl-2"> = </span><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">globalHeaderClient</span><span class="hl-2">;</span><br/><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">contactLink</span><span class="hl-2">: </span><span class="hl-13">MainLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-11">'Contact'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-11">'/contact'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">feedbackLink</span><span class="hl-2">: </span><span class="hl-13">MainLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-11">'Feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-11">'https://example.com/feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">isExternal:</span><span class="hl-2"> </span><span class="hl-9">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">target:</span><span class="hl-2"> </span><span class="hl-11">'_blank'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-6">client</span><span class="hl-2">.</span><span class="hl-6">accessMenu</span><span class="hl-2">.</span><span class="hl-7">setMainLinks</span><span class="hl-2">([</span><br/><span class="hl-2"> </span><span class="hl-6">contactLink</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">feedbackLink</span><span class="hl-2">,</span><br/><span class="hl-2">]);</span>
|
|
114
|
+
</code><button type="button">Copy</button></pre>
|
|
115
|
+
|
|
104
116
|
<a id="md:contact-information" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Contact Information<a href="#md:contact-information" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>If you need assistance or have any questions regarding the <strong>Global Header Widget</strong>, feel free to reach out to us:</p>
|
|
105
117
|
<ul>
|
|
106
|
-
<li><strong>Support Portal</strong>: <a href="https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2339897467/Widget-platform" target="_blank" class="external">
|
|
118
|
+
<li><strong>Support Portal</strong>: <a href="https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2339897467/Widget-platform" target="_blank" class="external">Widget platform</a></li>
|
|
107
119
|
</ul>
|
|
108
120
|
<p>Our team is here to help with any issues or inquiries you might have.</p>
|
|
109
|
-
<a id="md:
|
|
110
|
-
<li
|
|
121
|
+
<a id="md:search-keywords" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Search Keywords<a href="#md:search-keywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
122
|
+
<li>Global Header Integration</li>
|
|
123
|
+
<li>Flanders Widget Setup</li>
|
|
124
|
+
<li>Flanders Global Header</li>
|
|
125
|
+
<li>V5 Widget Migration</li>
|
|
126
|
+
<li>GlobalHeaderClient API</li>
|
|
127
|
+
<li>Embed Script Example</li>
|
|
128
|
+
<li>Entry Script Mounting</li>
|
|
129
|
+
<li>Multilingual Global Header</li>
|
|
130
|
+
<li>Language Switching in Widgets</li>
|
|
131
|
+
<li>Widget Browser Support</li>
|
|
132
|
+
<li>Global Header JavaScript API</li>
|
|
133
|
+
<li>Dynamic Header Links</li>
|
|
134
|
+
<li>TypeScript Widget Integration</li>
|
|
135
|
+
<li>Flanders Widget API Usage</li>
|
|
136
|
+
<li>V4 to V5 Migration Guide</li>
|
|
111
137
|
</ul>
|
|
112
|
-
</div></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"><a href="#md:adding-a-flanders-global-header-to-your-website"><span>Adding a <wbr/>Flanders <wbr/>Global <wbr/>Header to <wbr/>Your <wbr/>Website</span></a><ul><li><a href="#md:using-the-
|
|
138
|
+
</div></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"><a href="#md:introduction"><span>Introduction</span></a><a href="#md:adding-a-flanders-global-header-to-your-website"><span>Adding a <wbr/>Flanders <wbr/>Global <wbr/>Header to <wbr/>Your <wbr/>Website</span></a><ul><li><a href="#md:using-the-embed-script-automatic-mounting"><span>Using the <wbr/>Embed <wbr/>Script (<wbr/>Automatic <wbr/>Mounting)</span></a></li><li><a href="#md:using-the-entry-script-manual-mounting"><span>Using the <wbr/>Entry <wbr/>Script (<wbr/>Manual <wbr/>Mounting)</span></a></li><li><a href="#md:summary"><span>Summary</span></a></li></ul><a href="#md:using-the-windowglobalheaderclient-api"><span>Using the window.global<wbr/>Header<wbr/>Client API</span></a><a href="#md:migration-guide-upgrading-from-v4-to-v5"><span>Migration guide: <wbr/>Upgrading from v4 to v5</span></a><ul><li><a href="#md:remove-client-library-script-links"><span>Remove client library script links</span></a></li><li><a href="#md:eliminate-installable-packages"><span>Eliminate installable packages</span></a></li><li><a href="#md:update-embed-script-links"><span>Update <wbr/>Embed script links</span></a></li><li><a href="#md:update-api-usage"><span>Update API usage</span></a></li><li><a href="#md:accessing-windowglobalheaderclient"><span>Accessing window.global<wbr/>Header<wbr/>Client</span></a></li><li><a href="#md:verify-styling-and-rendering"><span>Verify <wbr/>Styling and <wbr/>Rendering</span></a></li></ul><a href="#md:language-switching"><span>Language <wbr/>Switching</span></a><a href="#md:browser-support"><span>Browser <wbr/>Support</span></a><a href="#md:typescript-support"><span>Typescript <wbr/>Support</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li><li><a href="#md:usage-example"><span>Usage example</span></a></li></ul><a href="#md:contact-information"><span>Contact <wbr/>Information</span></a><a href="#md:search-keywords"><span>Search <wbr/>Keywords</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Global Header</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AlertConfig | 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><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></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" data-base=".."><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="AlertConfig.html">AlertConfig</a></li></ul><h1>Interface AlertConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the configuration for the alert bar displayed on top of the header widget.</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">AlertConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#modifier">modifier</a><span class="tsd-signature-symbol">: </span><a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a><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/
|
|
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">AlertConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#modifier">modifier</a><span class="tsd-signature-symbol">: </span><a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a><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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/alert.ts#lines-6">global-header-types/src/alert.ts:6</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="AlertConfig.html#enabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled</span></a>
|
|
3
3
|
<a href="AlertConfig.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
4
4
|
<a href="AlertConfig.html#modifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modifier</span></a>
|
|
5
5
|
</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"><a id="enabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enabled</span><a href="#enabled" 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">enabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Shows or hides the alert bar on top of the header widget.</p>
|
|
6
|
-
</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/
|
|
7
|
-
</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/
|
|
8
|
-
</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/
|
|
6
|
+
</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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/alert.ts#lines-10">global-header-types/src/alert.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The content of the alert. This can be an HTML string.</p>
|
|
7
|
+
</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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/alert.ts#lines-15">global-header-types/src/alert.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="modifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>modifier</span><a href="#modifier" 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">modifier</span><span class="tsd-signature-symbol">:</span> <a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a></div><div class="tsd-comment tsd-typography"><p>Changes the icon and color of the alert.</p>
|
|
8
|
+
</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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/alert.ts#lines-20">global-header-types/src/alert.ts:20</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="tsd-otp-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="#enabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#modifier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modifier</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Global Header</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Application | 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><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></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" data-base=".."><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="Application.html">Application</a></li></ul><h1>Interface Application</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Holds application-specific settings.</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">Application</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="Application.html#isMainCapacity">isMainCapacity</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Application.html#mainCapacityCode">mainCapacityCode</a><span class="tsd-signature-symbol">: </span><a href="../types/CapacityCode.html" class="tsd-signature-type tsd-kind-type-alias">CapacityCode</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Application.html#name">name</a><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><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">Application</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="Application.html#isMainCapacity">isMainCapacity</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Application.html#mainCapacityCode">mainCapacityCode</a><span class="tsd-signature-symbol">: </span><a href="../types/CapacityCode.html" class="tsd-signature-type tsd-kind-type-alias">CapacityCode</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Application.html#name">name</a><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><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/access-menu.ts#lines-68">global-header-types/src/access-menu.ts:68</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="Application.html#isMainCapacity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Main<wbr/>Capacity</span></a>
|
|
3
3
|
<a href="Application.html#mainCapacityCode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main<wbr/>Capacity<wbr/>Code</span></a>
|
|
4
4
|
<a href="Application.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
|
5
5
|
</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"><a id="isMainCapacity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Main<wbr/>Capacity</span><a href="#isMainCapacity" 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">is<wbr/>Main<wbr/>Capacity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the application is a main capacity application.
|
|
@@ -9,7 +9,7 @@ This means the application is one of the following:</p>
|
|
|
9
9
|
<li>eLoket Ondernemers (<code>EA</code>)</li>
|
|
10
10
|
<li>Verenigingsloket (<code>VER</code>)</li>
|
|
11
11
|
</ul>
|
|
12
|
-
</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/
|
|
12
|
+
</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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/access-menu.ts#lines-76">global-header-types/src/access-menu.ts:76</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mainCapacityCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>main<wbr/>Capacity<wbr/>Code</span><a href="#mainCapacityCode" 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">main<wbr/>Capacity<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <a href="../types/CapacityCode.html" class="tsd-signature-type tsd-kind-type-alias">CapacityCode</a></div><div class="tsd-comment tsd-typography"><p>The main capacity code setting, which changes certain UI elements
|
|
13
13
|
like the eLoket icon.</p>
|
|
14
|
-
</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/
|
|
15
|
-
</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/
|
|
14
|
+
</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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/access-menu.ts#lines-82">global-header-types/src/access-menu.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The application name shown at the top of the access menu.</p>
|
|
15
|
+
</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/ab9891e1a7344b76d968c647fb0d833e9ff7244b/packages/global-header-types/src/access-menu.ts#lines-87">global-header-types/src/access-menu.ts:87</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="tsd-otp-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="#isMainCapacity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Main<wbr/>Capacity</span></a><a href="#mainCapacityCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main<wbr/>Capacity<wbr/>Code</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Global Header</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|