@govflanders/vl-widget-global-header-types 2.0.3 → 2.0.4
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 +41 -0
- package/dist/access-menu.d.ts +1 -1
- package/docs/assets/highlight.css +8 -8
- package/docs/functions/bootstrap.html +2 -2
- package/docs/index.html +41 -8
- 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/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 +12 -12
- 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 +8 -8
- 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/docs/types/Translatable.html +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,6 +23,8 @@ Example of using the embed script:
|
|
|
23
23
|
<title>Global header embed script example</title>
|
|
24
24
|
</head>
|
|
25
25
|
<body>
|
|
26
|
+
<!-- For the UUID, you should use your widget-id -->
|
|
27
|
+
<!-- If you want to use the TNI environment, use 'tni' instead of 'prod' -->
|
|
26
28
|
<script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/9717ae3b-84e8-43b2-a814-e35a2547927f/embed"></script>
|
|
27
29
|
<div class="your-website-code">👋 Hello world</div>
|
|
28
30
|
</body>
|
|
@@ -136,6 +138,45 @@ Example:
|
|
|
136
138
|
+ globalHeaderClient.contact.resetServicePoints();
|
|
137
139
|
```
|
|
138
140
|
|
|
141
|
+
#### Changes in Session Management
|
|
142
|
+
|
|
143
|
+
In version 5, the header no longer maintains a separate session state. This change entails:
|
|
144
|
+
|
|
145
|
+
- Elimination of inactivity checks
|
|
146
|
+
- Removal of background calls for additional session data
|
|
147
|
+
- Absence of a separate `sessionStorage`
|
|
148
|
+
|
|
149
|
+
This streamlining simplifies the session management process and reduces session-related errors.
|
|
150
|
+
|
|
151
|
+
#### Changes in the Profile Method
|
|
152
|
+
|
|
153
|
+
In version 5 of the Global Header Widget, there are significant updates to the profile management functionality:
|
|
154
|
+
|
|
155
|
+
- The `configure` method has been replaced by the `setProfile` method in the `accessMenu`.
|
|
156
|
+
- The `loginRedirectUrl` parameter is now deprecated.
|
|
157
|
+
- A new `idpData` object has been introduced, allowing you to pass additional user information, such as the user's name, if they are signed in.
|
|
158
|
+
|
|
159
|
+
**Example of Profile Method Usage:**
|
|
160
|
+
|
|
161
|
+
```diff
|
|
162
|
+
// Using widgets V4
|
|
163
|
+
- vl.widget.client.capture(
|
|
164
|
+
- // Required capture function.
|
|
165
|
+
- function(widget) {
|
|
166
|
+
- if (widget.getPluginTypeId() === 'global_header') {
|
|
167
|
+
- widget.getExtension('citizen_profile.session', 'unsafe').configure({ active: true });
|
|
168
|
+
- }
|
|
169
|
+
- },
|
|
170
|
+
- );
|
|
171
|
+
// Using widgets V5
|
|
172
|
+
+ globalHeaderClient.accessMenu.setProfile({ active: true });
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**Key Points:**
|
|
176
|
+
- Ensure to replace any instances of the `configure` method with `setProfile` in your codebase.
|
|
177
|
+
- Review your implementation for any dependencies on the deprecated `loginRedirectUrl`.
|
|
178
|
+
- Optional: Utilize the new `idpData` object to enhance user profile management by including relevant user details.
|
|
179
|
+
|
|
139
180
|
### Accessing `window.globalHeaderClient`
|
|
140
181
|
|
|
141
182
|
Unified Access via Scripts: In version 5, you can access the `window.globalHeaderClient` object regardless of whether you use the entry script or the embed script.
|
package/dist/access-menu.d.ts
CHANGED
|
@@ -9,14 +9,14 @@
|
|
|
9
9
|
--dark-hl-3: #9CDCFE;
|
|
10
10
|
--light-hl-4: #0000FF;
|
|
11
11
|
--dark-hl-4: #CE9178;
|
|
12
|
-
--light-hl-5: #
|
|
13
|
-
--dark-hl-5: #
|
|
14
|
-
--light-hl-6: #
|
|
15
|
-
--dark-hl-6: #
|
|
16
|
-
--light-hl-7: #
|
|
17
|
-
--dark-hl-7: #
|
|
18
|
-
--light-hl-8: #
|
|
19
|
-
--dark-hl-8: #
|
|
12
|
+
--light-hl-5: #008000;
|
|
13
|
+
--dark-hl-5: #6A9955;
|
|
14
|
+
--light-hl-6: #000000FF;
|
|
15
|
+
--dark-hl-6: #D4D4D4;
|
|
16
|
+
--light-hl-7: #001080;
|
|
17
|
+
--dark-hl-7: #9CDCFE;
|
|
18
|
+
--light-hl-8: #795E26;
|
|
19
|
+
--dark-hl-8: #DCDCAA;
|
|
20
20
|
--light-hl-9: #0000FF;
|
|
21
21
|
--dark-hl-9: #569CD6;
|
|
22
22
|
--light-hl-10: #0070C1;
|
|
@@ -1,8 +1,8 @@
|
|
|
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>bootstrap | 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><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"><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="bootstrap.html">bootstrap</a></li></ul><h1>Function bootstrap</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Bootstraps the GlobalHeaderClient by loading it from the specified entry URL.</p>
|
|
2
|
-
</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-12">import</span><span class="hl-2"> { </span><span class="hl-
|
|
2
|
+
</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-12">import</span><span class="hl-2"> { </span><span class="hl-7">bootstrap</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">url</span><span class="hl-2"> = </span><span class="hl-11">'https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/your-widget-id/entry'</span><span class="hl-2">;</span><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-12">await</span><span class="hl-2"> </span><span class="hl-8">bootstrap</span><span class="hl-2">(</span><span class="hl-7">url</span><span class="hl-2">);</span><br/><span class="hl-5">// Use the GlobalHeaderClient instance</span><br/><span class="hl-9">const</span><span class="hl-2"> </span><span class="hl-10">config</span><span class="hl-2"> = </span><span class="hl-12">await</span><span class="hl-2"> </span><span class="hl-7">client</span><span class="hl-2">.</span><span class="hl-8">getConfig</span><span class="hl-2">();</span>
|
|
3
3
|
</code><button type="button">Copy</button></pre>
|
|
4
4
|
|
|
5
5
|
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="bootstrap" class="tsd-anchor"></a><span class="tsd-kind-call-signature">bootstrap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GlobalHeaderClient.html" class="tsd-signature-type tsd-kind-interface">GlobalHeaderClient</a><span class="tsd-signature-symbol">></span><a href="#bootstrap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></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">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The entry URL which has a form like this:
|
|
6
6
|
<code>https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/your-widget-id/entry</code></p>
|
|
7
7
|
</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><a href="../interfaces/GlobalHeaderClient.html" class="tsd-signature-type tsd-kind-interface">GlobalHeaderClient</a><span class="tsd-signature-symbol">></span></h4><p>The GlobalHeaderClient object.</p>
|
|
8
|
-
<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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/packages/global-header-types/src/bootstrap.ts#lines-21">global-header-types/src/bootstrap.ts:21</a></li></ul></aside></li></ul></section></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></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> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|
package/docs/index.html
CHANGED
|
@@ -3,13 +3,13 @@
|
|
|
3
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
4
|
<a id="using-the-embed-script-automatic-mounting" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the Embed Script (Automatic Mounting)<a href="#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
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-
|
|
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-5"><!-- For the UUID, you should use your widget-id --></span><br/><span class="hl-2"> </span><span class="hl-5"><!-- If you want to use the TNI environment, use 'tni' instead of 'prod' --></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-6"> </span><span class="hl-3">src</span><span class="hl-6">=</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
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
10
|
<a id="using-the-entry-script-manual-mounting" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the Entry Script (Manual Mounting)<a href="#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
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-
|
|
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-6"> </span><span class="hl-3">src</span><span class="hl-6">=</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-6"> </span><span class="hl-7">window</span><span class="hl-6">.</span><span class="hl-7">globalHeaderClient</span><span class="hl-6">.</span><span class="hl-8">mount</span><span class="hl-6">(); </span><span class="hl-5">// Mount the header manually after the script has loaded</span><br/><span class="hl-6"> </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>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
15
|
<a id="summary" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Summary<a href="#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>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
</ul>
|
|
19
19
|
<a id="using-the-windowglobalheaderclient-api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Using the <code>window.globalHeaderClient</code> API<a href="#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="#typescript-support">here</a>).</p>
|
|
20
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-
|
|
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-7">window</span><span class="hl-2">.</span><span class="hl-7">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-7">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-7">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-7">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-7">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-7">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-7">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-7">client</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setMainLinks</span><span class="hl-2">([</span><br/><span class="hl-2"> </span><span class="hl-7">contactLink</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">feedbackLink</span><span class="hl-2">,</span><br/><span class="hl-2">]);</span>
|
|
22
22
|
</code><button type="button">Copy</button></pre>
|
|
23
23
|
|
|
24
24
|
<p>Checkout the <a href="./interfaces/GlobalHeaderClient.html">GlobalHeaderClient</a> here to see all the available methods.</p>
|
|
@@ -57,6 +57,39 @@ Action Required:</p>
|
|
|
57
57
|
+ globalHeaderClient.contact.resetServicePoints();
|
|
58
58
|
</code><button type="button">Copy</button></pre>
|
|
59
59
|
|
|
60
|
+
<a id="changes-in-session-management" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Changes in Session Management<a href="#changes-in-session-management" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>In version 5, the header no longer maintains a separate session state. This change entails:</p>
|
|
61
|
+
<ul>
|
|
62
|
+
<li>Elimination of inactivity checks</li>
|
|
63
|
+
<li>Removal of background calls for additional session data</li>
|
|
64
|
+
<li>Absence of a separate <code>sessionStorage</code></li>
|
|
65
|
+
</ul>
|
|
66
|
+
<p>This streamlining simplifies the session management process and reduces session-related errors.</p>
|
|
67
|
+
<a id="changes-in-the-profile-method" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Changes in the Profile Method<a href="#changes-in-the-profile-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>In version 5 of the Global Header Widget, there are significant updates to the profile management functionality:</p>
|
|
68
|
+
<ul>
|
|
69
|
+
<li>The <code>configure</code> method has been replaced by the <code>setProfile</code> method in the <code>accessMenu</code>.</li>
|
|
70
|
+
<li>The <code>loginRedirectUrl</code> parameter is now deprecated.</li>
|
|
71
|
+
<li>A new <code>idpData</code> object has been introduced, allowing you to pass additional user information, such as the user's name, if they are signed in.</li>
|
|
72
|
+
</ul>
|
|
73
|
+
<p><strong>Example of Profile Method Usage:</strong></p>
|
|
74
|
+
<pre><code class="diff">// Using widgets V4
|
|
75
|
+
- vl.widget.client.capture(
|
|
76
|
+
- // Required capture function.
|
|
77
|
+
- function(widget) {
|
|
78
|
+
- if (widget.getPluginTypeId() === 'global_header') {
|
|
79
|
+
- widget.getExtension('citizen_profile.session', 'unsafe').configure({ active: true });
|
|
80
|
+
- }
|
|
81
|
+
- },
|
|
82
|
+
- );
|
|
83
|
+
// Using widgets V5
|
|
84
|
+
+ globalHeaderClient.accessMenu.setProfile({ active: true });
|
|
85
|
+
</code><button type="button">Copy</button></pre>
|
|
86
|
+
|
|
87
|
+
<p><strong>Key Points:</strong></p>
|
|
88
|
+
<ul>
|
|
89
|
+
<li>Ensure to replace any instances of the <code>configure</code> method with <code>setProfile</code> in your codebase.</li>
|
|
90
|
+
<li>Review your implementation for any dependencies on the deprecated <code>loginRedirectUrl</code>.</li>
|
|
91
|
+
<li>Optional: Utilize the new <code>idpData</code> object to enhance user profile management by including relevant user details.</li>
|
|
92
|
+
</ul>
|
|
60
93
|
<a id="accessing-windowglobalheaderclient" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Accessing <code>window.globalHeaderClient</code><a href="#accessing-windowglobalheaderclient" 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>Unified Access via Scripts: In version 5, you can access the <code>window.globalHeaderClient</code> object regardless of whether you use the entry script or the embed script.</p>
|
|
61
94
|
<p>Action Required:</p>
|
|
62
95
|
<ul>
|
|
@@ -80,7 +113,7 @@ Action Required:</p>
|
|
|
80
113
|
<li>en (English)</li>
|
|
81
114
|
</ul>
|
|
82
115
|
<p>To change the document language, you can use the following JavaScript snippet:</p>
|
|
83
|
-
<pre><code class="js"><span class="hl-
|
|
116
|
+
<pre><code class="js"><span class="hl-7">window</span><span class="hl-2">.</span><span class="hl-7">document</span><span class="hl-2">.</span><span class="hl-7">documentElement</span><span class="hl-2">.</span><span class="hl-7">lang</span><span class="hl-2"> = </span><span class="hl-11">'nl'</span><span class="hl-2">; </span><span class="hl-5">// 'nl', 'en', 'de' or 'fr'</span>
|
|
84
117
|
</code><button type="button">Copy</button></pre>
|
|
85
118
|
|
|
86
119
|
<p>This will switch the document's language to Dutch, and the widget will automatically reflect the change.</p>
|
|
@@ -101,16 +134,16 @@ Action Required:</p>
|
|
|
101
134
|
<a id="typescript-support" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Typescript Support<a href="#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
135
|
<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
136
|
<a id="installation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Installation<a href="#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-
|
|
137
|
+
<pre><code class="bash"><span class="hl-8">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
138
|
</code><button type="button">Copy</button></pre>
|
|
106
139
|
|
|
107
140
|
<p>or</p>
|
|
108
|
-
<pre><code class="bash"><span class="hl-
|
|
141
|
+
<pre><code class="bash"><span class="hl-8">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
142
|
</code><button type="button">Copy</button></pre>
|
|
110
143
|
|
|
111
144
|
<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
145
|
<a id="usage-example" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Usage example<a href="#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-
|
|
146
|
+
<pre><code class="typescript"><span class="hl-12">import</span><span class="hl-2"> { </span><span class="hl-7">GlobalHeaderClient</span><span class="hl-2">, </span><span class="hl-7">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-7">window</span><span class="hl-2">.</span><span class="hl-7">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-7">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-7">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-7">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-7">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-7">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-7">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-7">client</span><span class="hl-2">.</span><span class="hl-7">accessMenu</span><span class="hl-2">.</span><span class="hl-8">setMainLinks</span><span class="hl-2">([</span><br/><span class="hl-2"> </span><span class="hl-7">contactLink</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">feedbackLink</span><span class="hl-2">,</span><br/><span class="hl-2">]);</span>
|
|
114
147
|
</code><button type="button">Copy</button></pre>
|
|
115
148
|
|
|
116
149
|
<a id="contact-information" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Contact Information<a href="#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>
|
|
@@ -135,4 +168,4 @@ Action Required:</p>
|
|
|
135
168
|
<li>Flanders Widget API Usage</li>
|
|
136
169
|
<li>V4 to V5 Migration Guide</li>
|
|
137
170
|
</ul>
|
|
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="#introduction"><span>Introduction</span></a><a href="#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="#using-the-embed-script-automatic-mounting"><span>Using the <wbr/>Embed <wbr/>Script (<wbr/>Automatic <wbr/>Mounting)</span></a></li><li><a href="#using-the-entry-script-manual-mounting"><span>Using the <wbr/>Entry <wbr/>Script (<wbr/>Manual <wbr/>Mounting)</span></a></li><li><a href="#summary"><span>Summary</span></a></li></ul><a href="#using-the-windowglobalheaderclient-api"><span>Using the window.global<wbr/>Header<wbr/>Client API</span></a><a href="#migration-guide-upgrading-from-v4-to-v5"><span>Migration guide: <wbr/>Upgrading from v4 to v5</span></a><ul><li><a href="#remove-client-library-script-links"><span>Remove client library script links</span></a></li><li><a href="#eliminate-installable-packages"><span>Eliminate installable packages</span></a></li><li><a href="#update-embed-script-links"><span>Update <wbr/>Embed script links</span></a></li><li><a href="#update-api-usage"><span>Update API usage</span></a></li><li><a href="#accessing-windowglobalheaderclient"><span>Accessing window.global<wbr/>Header<wbr/>Client</span></a></li><li><a href="#verify-styling-and-rendering"><span>Verify <wbr/>Styling and <wbr/>Rendering</span></a></li></ul><a href="#language-switching"><span>Language <wbr/>Switching</span></a><a href="#browser-support"><span>Browser <wbr/>Support</span></a><a href="#typescript-support"><span>Typescript <wbr/>Support</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#usage-example"><span>Usage example</span></a></li></ul><a href="#contact-information"><span>Contact <wbr/>Information</span></a><a href="#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">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> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|
|
171
|
+
</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="#introduction"><span>Introduction</span></a><a href="#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="#using-the-embed-script-automatic-mounting"><span>Using the <wbr/>Embed <wbr/>Script (<wbr/>Automatic <wbr/>Mounting)</span></a></li><li><a href="#using-the-entry-script-manual-mounting"><span>Using the <wbr/>Entry <wbr/>Script (<wbr/>Manual <wbr/>Mounting)</span></a></li><li><a href="#summary"><span>Summary</span></a></li></ul><a href="#using-the-windowglobalheaderclient-api"><span>Using the window.global<wbr/>Header<wbr/>Client API</span></a><a href="#migration-guide-upgrading-from-v4-to-v5"><span>Migration guide: <wbr/>Upgrading from v4 to v5</span></a><ul><li><a href="#remove-client-library-script-links"><span>Remove client library script links</span></a></li><li><a href="#eliminate-installable-packages"><span>Eliminate installable packages</span></a></li><li><a href="#update-embed-script-links"><span>Update <wbr/>Embed script links</span></a></li><li><a href="#update-api-usage"><span>Update API usage</span></a></li><li><ul><li><a href="#changes-in-session-management"><span>Changes in <wbr/>Session <wbr/>Management</span></a></li><li><a href="#changes-in-the-profile-method"><span>Changes in the <wbr/>Profile <wbr/>Method</span></a></li></ul></li><li><a href="#accessing-windowglobalheaderclient"><span>Accessing window.global<wbr/>Header<wbr/>Client</span></a></li><li><a href="#verify-styling-and-rendering"><span>Verify <wbr/>Styling and <wbr/>Rendering</span></a></li></ul><a href="#language-switching"><span>Language <wbr/>Switching</span></a><a href="#browser-support"><span>Browser <wbr/>Support</span></a><a href="#typescript-support"><span>Typescript <wbr/>Support</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#usage-example"><span>Usage example</span></a></li></ul><a href="#contact-information"><span>Contact <wbr/>Information</span></a><a href="#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">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> 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" data-base=".."><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-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"><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/> <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/> <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/> <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/> <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/> <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/> <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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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="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="#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">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> 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" data-base=".."><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-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"><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/> <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/> <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/> <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/> <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/> <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/> <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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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">isMainCapacity</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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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">mainCapacityCode</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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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/94f2022cdb561ecc0fd73649ebb2133a9ae1811a/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="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="#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">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> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|