@govflanders/vl-widget-global-header-types 2.0.25 → 2.0.26
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 +0 -1
- package/dist/client/contact.d.ts +6 -2
- package/dist/contact.d.ts +21 -3
- package/dist/idp.d.ts +1 -1
- package/docs/assets/hierarchy.js +1 -1
- package/docs/functions/bootstrap.html +2 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +2 -3
- package/docs/interfaces/AccessMenuMethods.html +10 -10
- package/docs/interfaces/AlertConfig.html +5 -5
- package/docs/interfaces/Application.html +5 -5
- package/docs/interfaces/ApplicationMenuLink.html +6 -6
- package/docs/interfaces/Authorization.html +7 -7
- package/docs/interfaces/BUR.html +6 -6
- package/docs/interfaces/BaseConfig.html +2 -2
- package/docs/interfaces/BaseEntity.html +5 -5
- package/docs/interfaces/BrandingConfigColors.html +4 -4
- package/docs/interfaces/BrandingConfigHost.html +6 -6
- package/docs/interfaces/BrandingConfigUmbrella.html +5 -5
- package/docs/interfaces/BrandingMethods.html +12 -12
- package/docs/interfaces/Channel.html +14 -14
- package/docs/interfaces/ContactMethods.html +9 -9
- package/docs/interfaces/ContactOption.html +16 -16
- package/docs/interfaces/ContactOptionRef.html +5 -5
- package/docs/interfaces/EA.html +5 -5
- package/docs/interfaces/EnrichedServicePoints.html +6 -6
- package/docs/interfaces/GID.html +5 -5
- package/docs/interfaces/GlobalHeaderClient.html +10 -10
- package/docs/interfaces/I18n.html +2 -2
- package/docs/interfaces/IDPData.html +5 -5
- package/docs/interfaces/Image.html +5 -5
- package/docs/interfaces/LB.html +5 -5
- package/docs/interfaces/LanguageLink.html +3 -3
- package/docs/interfaces/LanguageSwitcherMethods.html +2 -2
- package/docs/interfaces/Link.html +4 -4
- package/docs/interfaces/LinkWithTarget.html +5 -5
- package/docs/interfaces/MainLink.html +6 -6
- package/docs/interfaces/OV.html +5 -5
- package/docs/interfaces/ProfileConfig.html +8 -8
- package/docs/interfaces/RecursiveRecord.html +1 -1
- package/docs/interfaces/ResolveOptions.html +2 -2
- package/docs/interfaces/ServicePoints.html +6 -6
- package/docs/interfaces/Session.html +3 -3
- package/docs/interfaces/Translations.html +2 -2
- package/docs/interfaces/User.html +4 -4
- package/docs/interfaces/VER.html +5 -5
- package/docs/modules.html +1 -1
- package/docs/types/AlertModifier.html +1 -1
- package/docs/types/BrandingConfigLevel.html +2 -2
- package/docs/types/CapacityCode.html +2 -2
- package/docs/types/ChannelComponent.html +2 -2
- package/docs/types/ChannelIcon.html +2 -2
- package/docs/types/ChannelType.html +2 -2
- package/docs/types/CobrowseChannel.html +2 -2
- package/docs/types/ContactOptionSocialPlatform.html +2 -2
- package/docs/types/ContactServiceEndpoints.html +2 -2
- package/docs/types/EnrichedServicePoint.html +1 -1
- package/docs/types/Entity.html +2 -2
- package/docs/types/Language.html +1 -1
- package/docs/types/LanguageSwitcherCallback.html +2 -2
- package/docs/types/LanguageSwitcherConfig.html +2 -2
- package/docs/types/ServicePoint.html +2 -2
- package/docs/types/Translatable.html +2 -2
- package/docs/variables/languages.html +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -197,7 +197,6 @@ Unified Access via Scripts: In version 5, you can access the `window.globalHeade
|
|
|
197
197
|
|
|
198
198
|
Action Required:
|
|
199
199
|
- Ensure that you include either the entry script or the embed script in your HTML.
|
|
200
|
-
- Remove any additional scripts previously used to access `window.globalHeaderClient`.
|
|
201
200
|
|
|
202
201
|
### Verify Styling and Rendering
|
|
203
202
|
After integrating version 5 of the widget into your website, it’s important to thoroughly review its appearance and functionality to ensure everything works as expected. Some styling adjustments might be necessary due to changes in the widget’s design or your site’s CSS.
|
package/dist/client/contact.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Translatable } from '../i18n';
|
|
2
|
-
import { EnrichedServicePoints, ServicePoints } from '../contact';
|
|
2
|
+
import { EnrichedServicePoints, ServicePoints, DigitalAssistantConfig } from '../contact';
|
|
3
3
|
export interface ContactMethods {
|
|
4
4
|
/**
|
|
5
5
|
* Get the current service points
|
|
@@ -50,7 +50,7 @@ export interface ContactMethods {
|
|
|
50
50
|
* // Open the chat directly
|
|
51
51
|
* const isOpen = await globalHeaderClient.contact.open('chat');
|
|
52
52
|
*/
|
|
53
|
-
open: (channel?: 'chat' | 'mail') => Promise<boolean>;
|
|
53
|
+
open: (channel?: 'chat' | 'mail' | 'digital-assistant') => Promise<boolean>;
|
|
54
54
|
/**
|
|
55
55
|
* Close the contact panel.
|
|
56
56
|
* @returns A promise that resolves to true if the contact panel was closed.
|
|
@@ -76,4 +76,8 @@ export interface ContactMethods {
|
|
|
76
76
|
* @ignore
|
|
77
77
|
*/
|
|
78
78
|
setFullScreen: (fullScreen: boolean) => Promise<boolean>;
|
|
79
|
+
/**
|
|
80
|
+
* @ignore
|
|
81
|
+
*/
|
|
82
|
+
configureDigitalAssistant: (config: DigitalAssistantConfig) => Promise<boolean>;
|
|
79
83
|
}
|
package/dist/contact.d.ts
CHANGED
|
@@ -75,6 +75,10 @@ export type ContactServiceEndpoints = Partial<{
|
|
|
75
75
|
* Endpoint to send mail form data.
|
|
76
76
|
*/
|
|
77
77
|
sendMailFormDataMessage: string;
|
|
78
|
+
/**
|
|
79
|
+
* Endpoint for the digital assistant.
|
|
80
|
+
*/
|
|
81
|
+
digitalAssistant: string;
|
|
78
82
|
}>;
|
|
79
83
|
/**
|
|
80
84
|
* Configuration for the contact plugin.
|
|
@@ -291,11 +295,11 @@ interface ContactPrivacy {
|
|
|
291
295
|
/**
|
|
292
296
|
* Represents the icon types for channels.
|
|
293
297
|
*/
|
|
294
|
-
export type ChannelIcon = 'call' | 'mail' | 'chat' | 'screen' | 'location';
|
|
298
|
+
export type ChannelIcon = 'call' | 'mail' | 'chat' | 'screen' | 'location' | 'digital-assistant';
|
|
295
299
|
/**
|
|
296
300
|
* Represents the type of a channel.
|
|
297
301
|
*/
|
|
298
|
-
export type ChannelType = 'link-mobile' | 'form' | 'chat' | 'link' | 'location';
|
|
302
|
+
export type ChannelType = 'link-mobile' | 'form' | 'chat' | 'link' | 'location' | 'digital-assistant';
|
|
299
303
|
/**
|
|
300
304
|
* Represents the component of a channel.
|
|
301
305
|
*/
|
|
@@ -311,7 +315,7 @@ export interface Channel {
|
|
|
311
315
|
/**
|
|
312
316
|
* The component of the channel.
|
|
313
317
|
*/
|
|
314
|
-
component
|
|
318
|
+
component?: ChannelComponent;
|
|
315
319
|
/**
|
|
316
320
|
* Name of the channel.
|
|
317
321
|
*/
|
|
@@ -425,4 +429,18 @@ interface ContactOptionAvailabilityException {
|
|
|
425
429
|
*/
|
|
426
430
|
hours?: ContactOptionTimeSlot[];
|
|
427
431
|
}
|
|
432
|
+
/**
|
|
433
|
+
* Configuration for the digital assistant.
|
|
434
|
+
* @ignore
|
|
435
|
+
*/
|
|
436
|
+
export interface DigitalAssistantConfig {
|
|
437
|
+
/**
|
|
438
|
+
* If `true`, the digital assistant will be active.
|
|
439
|
+
*/
|
|
440
|
+
active: boolean;
|
|
441
|
+
/**
|
|
442
|
+
* The domain to be used by the digital assistant.
|
|
443
|
+
*/
|
|
444
|
+
domain?: string;
|
|
445
|
+
}
|
|
428
446
|
export {};
|
package/dist/idp.d.ts
CHANGED
|
@@ -128,7 +128,7 @@ export interface Authorization {
|
|
|
128
128
|
/**
|
|
129
129
|
* The capacity of the user.
|
|
130
130
|
*/
|
|
131
|
-
capacity
|
|
131
|
+
capacity?: 'BUR' | 'GID' | 'VER' | 'EA' | 'LB' | 'OV';
|
|
132
132
|
/**
|
|
133
133
|
* The entity on behalf of which the user is acting, if applicable.
|
|
134
134
|
*/
|
package/docs/assets/hierarchy.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
window.hierarchyData = "
|
|
1
|
+
window.hierarchyData = "eJyVlM9vgjAUgP+Xd66b8CgCN5nEmZi4uMkOhgODKo1YkrZbshj+9wUPpltcWi49vfd971d6Adl1WkGyR/QIRiHxg7ggINmhZZXmnVCQXCAcHlGeGSSQylLUXByfOnHgx935Q7K2LYHAiYsaEp+GBD5lCwlwoZk8lBVTj/eTHhp9boFA1ZZKQQJa1ZOBMrllQk/Am/5rf+6UHmUeEtysfhAb2lcmv3jFXjoutLIYf8U6yAhUDW9ryQQke58GxWCngWHPhORVw+oxVdzNcWsd0TMnXiqWCc31t23St8CxTSNSghgTDJBgMCNIPYKUFtdaqFHLcrWwFLFcLVybNPebZ1sLOM+2juAADfA6tXDXqSt2ZmA3uQW7yR2x1Nx1Nrdd1dwVa64t3dmmm+5cpxuZf9Gai5NtvlycRt9jFF9vL4r/uN65bt5KeWS2X+d38Fh/SLxp0ff9D2Fl0ZQ="
|
|
@@ -1,8 +1,8 @@
|
|
|
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 - v2.0.
|
|
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 - v2.0.25</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header - v2.0.25</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
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-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-11">url</span><span class="hl-2"> = </span><span class="hl-9">'https://widgets.vlaanderen.be/api/v2/widget/your-widget-id/entry'</span><span class="hl-2">;</span><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-11">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-10">const</span><span class="hl-2"> </span><span class="hl-11">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://widgets.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/4e542375e0cbcab57624d41c254900e7ab4f04ac/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 - v2.0.25</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/docs/hierarchy.html
CHANGED
|
@@ -1 +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>Global Header - v2.0.
|
|
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>Global Header - v2.0.25</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Global Header - v2.0.25</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 - v2.0.25</h1></div><h2>Hierarchy Summary</h2><ul class="tsd-full-hierarchy"><li data-refl="331"><a id="BaseEntity" class="tsd-anchor"></a><a href="interfaces/BaseEntity.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BaseEntity</a><ul><li data-refl="335"><a id="GID" class="tsd-anchor"></a><a href="interfaces/GID.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>GID</a></li><li data-refl="339"><a id="VER" class="tsd-anchor"></a><a href="interfaces/VER.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>VER</a></li><li data-refl="343"><a id="LB" class="tsd-anchor"></a><a href="interfaces/LB.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>LB</a></li><li data-refl="347"><a id="OV" class="tsd-anchor"></a><a href="interfaces/OV.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>OV</a></li><li data-refl="351"><a id="EA" class="tsd-anchor"></a><a href="interfaces/EA.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>EA</a></li><li data-refl="355"><a id="BUR" class="tsd-anchor"></a><a href="interfaces/BUR.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BUR</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="386"><a id="Link" class="tsd-anchor"></a><a href="interfaces/Link.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>Link</a><ul><li data-refl="389"><a id="LinkWithTarget" class="tsd-anchor"></a><a href="interfaces/LinkWithTarget.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>LinkWithTarget</a><ul><li data-refl="6"><a id="BrandingConfigUmbrella" class="tsd-anchor"></a><a href="interfaces/BrandingConfigUmbrella.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BrandingConfigUmbrella</a></li><li data-refl="10"><a id="BrandingConfigHost" class="tsd-anchor"></a><a href="interfaces/BrandingConfigHost.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BrandingConfigHost</a></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="249"><a id="ServicePoints" class="tsd-anchor"></a><a href="interfaces/ServicePoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ServicePoints</a><ul><li data-refl="254"><a id="EnrichedServicePoints" class="tsd-anchor"></a><a href="interfaces/EnrichedServicePoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>EnrichedServicePoints</a></li></ul></li></ul></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 - v2.0.25</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/docs/index.html
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Global Header - v2.0.
|
|
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>Global Header - v2.0.25</title><meta name="description" content="Documentation for Global Header"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Global Header - v2.0.25</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 - v2.0.25</h1></div><div class="tsd-panel tsd-typography"><a id="introduction" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Introduction<a href="#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
2
|
<a id="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="#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
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>
|
|
@@ -98,7 +98,6 @@ Action Required:</p>
|
|
|
98
98
|
<p>Action Required:</p>
|
|
99
99
|
<ul>
|
|
100
100
|
<li>Ensure that you include either the entry script or the embed script in your HTML.</li>
|
|
101
|
-
<li>Remove any additional scripts previously used to access <code>window.globalHeaderClient</code>.</li>
|
|
102
101
|
</ul>
|
|
103
102
|
<a id="verify-styling-and-rendering" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Verify Styling and Rendering<a href="#verify-styling-and-rendering" 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>After integrating version 5 of the widget into your website, it’s important to thoroughly review its appearance and functionality to ensure everything works as expected. Some styling adjustments might be necessary due to changes in the widget’s design or your site’s CSS.</p>
|
|
104
103
|
<p>Action Required:</p>
|
|
@@ -308,4 +307,4 @@ Action Required:</p>
|
|
|
308
307
|
<li>Flanders Widget API Usage</li>
|
|
309
308
|
<li>V4 to V5 Migration Guide</li>
|
|
310
309
|
</ul>
|
|
311
|
-
</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="#content-security-policy-csp"><span>Content <wbr/>Security <wbr/>Policy (CSP)</span></a><ul><li><a href="#production-environment-csp-configuration"><span>Production <wbr/>Environment CSP <wbr/>Configuration</span></a></li><li><a href="#tni-environment-csp-configuration"><span>TNI <wbr/>Environment CSP <wbr/>Configuration</span></a></li><li><a href="#additional-csp-for-screensharing"><span>Additional CSP for <wbr/>Screensharing</span></a></li><li><a href="#further-information"><span>Further <wbr/>Information</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">Global Header - v2.0.
|
|
310
|
+
</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="#content-security-policy-csp"><span>Content <wbr/>Security <wbr/>Policy (CSP)</span></a><ul><li><a href="#production-environment-csp-configuration"><span>Production <wbr/>Environment CSP <wbr/>Configuration</span></a></li><li><a href="#tni-environment-csp-configuration"><span>TNI <wbr/>Environment CSP <wbr/>Configuration</span></a></li><li><a href="#additional-csp-for-screensharing"><span>Additional CSP for <wbr/>Screensharing</span></a></li><li><a href="#further-information"><span>Further <wbr/>Information</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">Global Header - v2.0.25</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|