@govflanders/vl-widget-global-header-types 1.0.36 → 1.0.38
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 +12 -56
- package/docs/index.html +13 -19
- package/docs/interfaces/AccessMenuConfig.html +2 -2
- package/docs/interfaces/AlertConfig.html +4 -4
- package/docs/interfaces/Application.html +2 -2
- package/docs/interfaces/ApplicationLink.html +2 -2
- package/docs/interfaces/BrandingConfig.html +2 -2
- package/docs/interfaces/BrandingConfigColors.html +2 -2
- package/docs/interfaces/BrandingConfigHost.html +2 -2
- package/docs/interfaces/BrandingConfigUmbrella.html +2 -2
- package/docs/interfaces/Channel.html +2 -2
- package/docs/interfaces/CobrowseConfig.html +2 -2
- package/docs/interfaces/CobrowseConsentConfig.html +2 -2
- package/docs/interfaces/Config.html +2 -2
- package/docs/interfaces/ContactConfig.html +2 -2
- package/docs/interfaces/ContactOption.html +2 -2
- package/docs/interfaces/ContactOptionRef.html +2 -2
- package/docs/interfaces/EnrichedServicePoints.html +2 -2
- package/docs/interfaces/GlobalHeaderClient.html +8 -8
- package/docs/interfaces/IDPData.html +2 -2
- package/docs/interfaces/Image.html +2 -2
- package/docs/interfaces/Link.html +2 -2
- package/docs/interfaces/LinkWithTarget.html +2 -2
- package/docs/interfaces/MainLink.html +2 -2
- package/docs/interfaces/ProfileConfig.html +7 -7
- package/docs/interfaces/ServicePoints.html +2 -2
- package/docs/interfaces/Session.html +2 -2
- package/docs/types/AlertModifier.html +1 -1
- package/docs/types/ApplicationMenuLink.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/PluginTypeId.html +1 -1
- package/docs/types/ServicePoint.html +1 -1
- package/docs/types/Translatable.html +6 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ By using the types defined in this package, developers can ensure type-safe inte
|
|
|
6
6
|
|
|
7
7
|
You can integrate the **Flanders Global Header** into your website using one of two methods: the **entry script** or the **embed script**. Each serves a different purpose:
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### Using the Entry Script
|
|
10
10
|
|
|
11
11
|
The entry script should be placed in the `<head>` section of your HTML, preferably at the top. This is essential because the `globalHeaderClient` 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 `mount` method to display it.
|
|
12
12
|
|
|
@@ -30,7 +30,7 @@ Example of using the entry script:
|
|
|
30
30
|
</html>
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
###
|
|
33
|
+
### Using the Embed Script
|
|
34
34
|
|
|
35
35
|
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.
|
|
36
36
|
|
|
@@ -71,7 +71,7 @@ yarn add -D @govflanders/vl-widget-global-header-types
|
|
|
71
71
|
**Note:** It’s recommended to use the caret (^) symbol in your package.json to stay updated with the latest minor and patch versions.
|
|
72
72
|
|
|
73
73
|
## Usage
|
|
74
|
-
This package provides all the types required for working with the Global Header Widget. The widget is available on the global window object as window.globalHeaderClient
|
|
74
|
+
This package provides all the types required for working with the Global Header Widget. The widget is available on the global window object as `window.globalHeaderClient`. You can import the types from global-header-types to use them in your project.
|
|
75
75
|
|
|
76
76
|
Example of using the types to interact with the widget:
|
|
77
77
|
```typescript
|
|
@@ -97,24 +97,20 @@ client.setMainLinks([
|
|
|
97
97
|
]);
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
The `window.globalHeaderClient` object offers several methods for interacting with the widget. Each method is typed and returns promises, making asynchronous operations easier to handle. Below is a detailed breakdown of each method, its parameters, and the expected return values.
|
|
103
|
-
|
|
104
|
-
Checkout the [GlobalHeaderClient](./interfaces/GlobalHeaderClient.html) here to see how to use it.
|
|
100
|
+
Checkout the [GlobalHeaderClient](./interfaces/GlobalHeaderClient.html) here to see all the available methods.
|
|
105
101
|
|
|
106
102
|
## Migration guide: Upgrading from v4 to v5
|
|
107
103
|
|
|
108
104
|
If you’re currently using version 4 of the Global Header Widget, please follow this guide to upgrade to version 5. This guide highlights the key changes and steps you need to take to ensure a smooth transition.
|
|
109
105
|
|
|
110
|
-
###
|
|
106
|
+
### Remove client library script links
|
|
111
107
|
|
|
112
108
|
No more client library or polyfill scripts: In version 5, you no longer need to include any additional client library or polyfill script links in your HTML. Access to the `window.globalHeaderClient` object is automatically provided when you include either the entry script or the embed script.
|
|
113
109
|
Action Required:
|
|
114
110
|
- Remove any `<script>` tags that reference client libraries or polyfill libraries for the widget.
|
|
115
111
|
- Ensure that either the entry script or the embed script is included in your HTML.
|
|
116
112
|
|
|
117
|
-
###
|
|
113
|
+
### Eliminate installable packages
|
|
118
114
|
|
|
119
115
|
Script-based integration only: Version 5 removes the need for installable packages via npm or yarn. All functionalities are now accessible by including script tags directly in your HTML’s `<head>` or `<body>` section.
|
|
120
116
|
|
|
@@ -122,11 +118,11 @@ Action Required:
|
|
|
122
118
|
- Uninstall any npm or yarn packages related to the widget
|
|
123
119
|
- Delete any import or require statements in your JavaScript code that reference the widget.
|
|
124
120
|
|
|
125
|
-
###
|
|
121
|
+
### Update Embed script links
|
|
126
122
|
|
|
127
123
|
Version Update in Embed Links: If you’re using the embed script method to include the widget, you need to update the version number in your script’s src URL from 'v1' to 'v2'. [Example here](#adding-a-flanders-global-header-to-your-website).
|
|
128
124
|
|
|
129
|
-
###
|
|
125
|
+
### Update API usage
|
|
130
126
|
|
|
131
127
|
API Changes: The globalHeaderClient API has been updated in version 5. Methods, their signatures, and usage patterns may have changed. Refer to the [API](#api) section for detailed information on the new methods and their parameters.
|
|
132
128
|
|
|
@@ -151,15 +147,15 @@ Example:
|
|
|
151
147
|
+ globalHeaderClient.contact.resetServicePoints();
|
|
152
148
|
```
|
|
153
149
|
|
|
154
|
-
###
|
|
150
|
+
### Accessing `window.globalHeaderClient`
|
|
155
151
|
|
|
156
152
|
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.
|
|
157
153
|
|
|
158
154
|
Action Required:
|
|
159
155
|
- Ensure that you include either the entry script or the embed script in your HTML.
|
|
160
|
-
- Remove any additional scripts previously used to access window.globalHeaderClient
|
|
156
|
+
- Remove any additional scripts previously used to access `window.globalHeaderClient`.
|
|
161
157
|
|
|
162
|
-
###
|
|
158
|
+
### Verify Styling and Rendering
|
|
163
159
|
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.
|
|
164
160
|
|
|
165
161
|
Action Required:
|
|
@@ -169,9 +165,7 @@ Action Required:
|
|
|
169
165
|
- Adjust Styles if Needed: Modify your CSS or override styles to resolve any layout or design issues.
|
|
170
166
|
- Seek Assistance: If problems persist, don’t hesitate to [contact us](#contact-information) for support.
|
|
171
167
|
|
|
172
|
-
##
|
|
173
|
-
|
|
174
|
-
### Language Switching
|
|
168
|
+
## Language Switching
|
|
175
169
|
|
|
176
170
|
The widget automatically adapts to the language of the document. It observes the `lang` attribute on the `<html>` tag, so it's the implementer's responsibility to handle any language switching functionality. If the `lang` attribute changes, the widget will update to display the correct language.
|
|
177
171
|
|
|
@@ -191,44 +185,6 @@ This will switch the document's language to Dutch, and the widget will automatic
|
|
|
191
185
|
|
|
192
186
|
Note: When using a multilingual widget, ensure its configuration also supports multiple languages.
|
|
193
187
|
|
|
194
|
-
### Translatable Type
|
|
195
|
-
|
|
196
|
-
The `Translatable<T>` type allows an object to either be a single value or a language-specific dictionary. This is useful when content needs to be available in multiple languages.
|
|
197
|
-
|
|
198
|
-
#### Example
|
|
199
|
-
|
|
200
|
-
For example, `setMainLinks` can accept single-language or multi-language links:
|
|
201
|
-
|
|
202
|
-
```typescript
|
|
203
|
-
const singleLanguageLink: Translatable<MainLink> = {
|
|
204
|
-
label: 'Home',
|
|
205
|
-
href: 'https://www.example.com',
|
|
206
|
-
};
|
|
207
|
-
|
|
208
|
-
const multiLanguageLink: Translatable<MainLink> = {
|
|
209
|
-
nl: {
|
|
210
|
-
label: 'Startpagina',
|
|
211
|
-
href: 'https://www.example.com/nl',
|
|
212
|
-
},
|
|
213
|
-
en: {
|
|
214
|
-
label: 'Home',
|
|
215
|
-
href: 'https://www.example.com/en',
|
|
216
|
-
},
|
|
217
|
-
fr: {
|
|
218
|
-
label: 'Accueil',
|
|
219
|
-
href: 'https://www.example.com/fr',
|
|
220
|
-
},
|
|
221
|
-
de: {
|
|
222
|
-
label: 'Startseite',
|
|
223
|
-
href: 'https://www.example.com/de',
|
|
224
|
-
},
|
|
225
|
-
};
|
|
226
|
-
|
|
227
|
-
client.setMainLinks([singleLanguageLink]);
|
|
228
|
-
// or
|
|
229
|
-
client.setMainLinks([multiLanguageLink]);
|
|
230
|
-
```
|
|
231
|
-
|
|
232
188
|
## Browser Support
|
|
233
189
|
|
|
234
190
|
The **Global Header Widget** supports the two most recent versions of all major browsers:
|
package/docs/index.html
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Global Header Client</title><meta name="description" content="Documentation for Global Header Client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Global Header Client</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 Client</h1></div><div class="tsd-panel tsd-typography"><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>
|
|
2
2
|
<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>
|
|
3
3
|
<a id="md:adding-a-flanders-global-header-to-your-website" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Adding a Flanders Global Header to Your Website<a href="#md:adding-a-flanders-global-header-to-your-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can integrate the <strong>Flanders Global Header</strong> into your website using one of two methods: the <strong>entry script</strong> or the <strong>embed script</strong>. Each serves a different purpose:</p>
|
|
4
|
-
<a id="md:
|
|
4
|
+
<a id="md:using-the-entry-script" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the Entry Script<a href="#md:using-the-entry-script" 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>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>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>
|
|
5
5
|
<p>Example of using the entry script:</p>
|
|
6
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">script</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"https://widgets.test-vlaanderen.be/api/v2/widget/9717ae3b-84e8-43b2-a814-e35a2547927f/entry"</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"UTF-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1.0"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">Global header entry script example</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-2"> </span><span class="hl-3">class</span><span class="hl-2">=</span><span class="hl-4">"your-website-code"</span><span class="hl-0">></span><span class="hl-2">👋 Hello world</span><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-6">globalHeaderClient</span><span class="hl-5">.</span><span class="hl-7">mount</span><span class="hl-5">(); </span><span class="hl-8">// Mount the header manually after the script has loaded</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">html</span><span class="hl-0">></span>
|
|
7
7
|
</code><button type="button">Copy</button></pre>
|
|
8
8
|
|
|
9
|
-
<a id="md:
|
|
9
|
+
<a id="md:using-the-embed-script" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the Embed Script<a href="#md:using-the-embed-script" 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>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>
|
|
10
10
|
<p>Example of using the embed script:</p>
|
|
11
11
|
<pre><code class="html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-2"> </span><span class="hl-3">lang</span><span class="hl-2">=</span><span class="hl-4">"nl"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"UTF-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1.0"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">Global header embed script example</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"https://widgets.test-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>
|
|
12
12
|
</code><button type="button">Copy</button></pre>
|
|
@@ -24,28 +24,27 @@
|
|
|
24
24
|
</code><button type="button">Copy</button></pre>
|
|
25
25
|
|
|
26
26
|
<p><strong>Note:</strong> It’s recommended to use the caret (^) symbol in your package.json to stay updated with the latest minor and patch versions.</p>
|
|
27
|
-
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This package provides all the types required for working with the Global Header Widget. The widget is available on the global window object as window.globalHeaderClient
|
|
27
|
+
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This package provides all the types required for working with the Global Header Widget. The widget is available on the global window object as <code>window.globalHeaderClient</code>. You can import the types from global-header-types to use them in your project.</p>
|
|
28
28
|
<p>Example of using the types to interact with the widget:</p>
|
|
29
29
|
<pre><code class="typescript"><span class="hl-11">import</span><span class="hl-2"> { </span><span class="hl-6">GlobalHeaderClient</span><span class="hl-2">, </span><span class="hl-6">MainLink</span><span class="hl-2"> } </span><span class="hl-11">from</span><span class="hl-2"> </span><span class="hl-9">'@govflanders/vl-widget-global-header-types'</span><span class="hl-2">;</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">client</span><span class="hl-2">: </span><span class="hl-13">GlobalHeaderClient</span><span class="hl-2"> = </span><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">globalHeaderClient</span><span class="hl-2">;</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">contactLink</span><span class="hl-2">: </span><span class="hl-13">MainLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Contact'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'/contact'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">feedbackLink</span><span class="hl-2">: </span><span class="hl-13">MainLink</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://example.com/feedback'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">isExternal:</span><span class="hl-2"> </span><span class="hl-10">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">target:</span><span class="hl-2"> </span><span class="hl-9">'_blank'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-6">client</span><span class="hl-2">.</span><span class="hl-7">setMainLinks</span><span class="hl-2">([</span><br/><span class="hl-2"> </span><span class="hl-6">contactLink</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">feedbackLink</span><span class="hl-2">,</span><br/><span class="hl-2">]);</span>
|
|
30
30
|
</code><button type="button">Copy</button></pre>
|
|
31
31
|
|
|
32
|
-
<
|
|
33
|
-
<p>Checkout the <a href="./interfaces/GlobalHeaderClient.html">GlobalHeaderClient</a> here to see how to use it.</p>
|
|
32
|
+
<p>Checkout the <a href="./interfaces/GlobalHeaderClient.html">GlobalHeaderClient</a> here to see all the available methods.</p>
|
|
34
33
|
<a id="md:migration-guide-upgrading-from-v4-to-v5" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Migration guide: Upgrading from v4 to v5<a href="#md:migration-guide-upgrading-from-v4-to-v5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>If you’re currently using version 4 of the Global Header Widget, please follow this guide to upgrade to version 5. This guide highlights the key changes and steps you need to take to ensure a smooth transition.</p>
|
|
35
|
-
<a id="md:
|
|
34
|
+
<a id="md:remove-client-library-script-links" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Remove client library script links<a href="#md:remove-client-library-script-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>No more client library or polyfill scripts: In version 5, you no longer need to include any additional client library or polyfill script links in your HTML. Access to the <code>window.globalHeaderClient</code> object is automatically provided when you include either the entry script or the embed script.
|
|
36
35
|
Action Required:</p>
|
|
37
36
|
<ul>
|
|
38
37
|
<li>Remove any <code><script></code> tags that reference client libraries or polyfill libraries for the widget.</li>
|
|
39
38
|
<li>Ensure that either the entry script or the embed script is included in your HTML.</li>
|
|
40
39
|
</ul>
|
|
41
|
-
<a id="md:
|
|
40
|
+
<a id="md:eliminate-installable-packages" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Eliminate installable packages<a href="#md:eliminate-installable-packages" 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>Script-based integration only: Version 5 removes the need for installable packages via npm or yarn. All functionalities are now accessible by including script tags directly in your HTML’s <code><head></code> or <code><body></code> section.</p>
|
|
42
41
|
<p>Action Required:</p>
|
|
43
42
|
<ul>
|
|
44
43
|
<li>Uninstall any npm or yarn packages related to the widget</li>
|
|
45
44
|
<li>Delete any import or require statements in your JavaScript code that reference the widget.</li>
|
|
46
45
|
</ul>
|
|
47
|
-
<a id="md:
|
|
48
|
-
<a id="md:
|
|
46
|
+
<a id="md:update-embed-script-links" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Update Embed script links<a href="#md:update-embed-script-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Version Update in Embed Links: If you’re using the embed script method to include the widget, you need to update the version number in your script’s src URL from 'v1' to 'v2'. <a href="#md:adding-a-flanders-global-header-to-your-website">Example here</a>.</p>
|
|
47
|
+
<a id="md:update-api-usage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Update API usage<a href="#md:update-api-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>API Changes: The globalHeaderClient API has been updated in version 5. Methods, their signatures, and usage patterns may have changed. Refer to the <a href="#md:api">API</a> section for detailed information on the new methods and their parameters.</p>
|
|
49
48
|
<p>Action Required:</p>
|
|
50
49
|
<ul>
|
|
51
50
|
<li>Review all instances where you interact with globalHeaderClient.</li>
|
|
@@ -66,13 +65,13 @@ Action Required:</p>
|
|
|
66
65
|
+ globalHeaderClient.contact.resetServicePoints();
|
|
67
66
|
</code><button type="button">Copy</button></pre>
|
|
68
67
|
|
|
69
|
-
<a id="md:
|
|
68
|
+
<a id="md:accessing-windowglobalheaderclient" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Accessing <code>window.globalHeaderClient</code><a href="#md: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>
|
|
70
69
|
<p>Action Required:</p>
|
|
71
70
|
<ul>
|
|
72
71
|
<li>Ensure that you include either the entry script or the embed script in your HTML.</li>
|
|
73
|
-
<li>Remove any additional scripts previously used to access window.globalHeaderClient
|
|
72
|
+
<li>Remove any additional scripts previously used to access <code>window.globalHeaderClient</code>.</li>
|
|
74
73
|
</ul>
|
|
75
|
-
<a id="md:
|
|
74
|
+
<a id="md:verify-styling-and-rendering" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Verify Styling and Rendering<a href="#md: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>
|
|
76
75
|
<p>Action Required:</p>
|
|
77
76
|
<ul>
|
|
78
77
|
<li>Test Across Browsers: Check the widget in all supported browsers to confirm consistent styling and behavior.</li>
|
|
@@ -80,7 +79,7 @@ Action Required:</p>
|
|
|
80
79
|
<li>Adjust Styles if Needed: Modify your CSS or override styles to resolve any layout or design issues.</li>
|
|
81
80
|
<li>Seek Assistance: If problems persist, don’t hesitate to <a href="#md:contact-information">contact us</a> for support.</li>
|
|
82
81
|
</ul>
|
|
83
|
-
<a id="md:
|
|
82
|
+
<a id="md:language-switching" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Language Switching<a href="#md:language-switching" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The widget automatically adapts to the language of the document. It observes the <code>lang</code> attribute on the <code><html></code> tag, so it's the implementer's responsibility to handle any language switching functionality. If the <code>lang</code> attribute changes, the widget will update to display the correct language.</p>
|
|
84
83
|
<p>Supported languages:</p>
|
|
85
84
|
<ul>
|
|
86
85
|
<li>nl (Dutch)</li>
|
|
@@ -94,11 +93,6 @@ Action Required:</p>
|
|
|
94
93
|
|
|
95
94
|
<p>This will switch the document's language to Dutch, and the widget will automatically reflect the change.</p>
|
|
96
95
|
<p>Note: When using a multilingual widget, ensure its configuration also supports multiple languages.</p>
|
|
97
|
-
<a id="md:translatable-type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Translatable Type<a href="#md:translatable-type" 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>The <code>Translatable<T></code> type allows an object to either be a single value or a language-specific dictionary. This is useful when content needs to be available in multiple languages.</p>
|
|
98
|
-
<a id="md:example" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Example<a href="#md: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><p>For example, <code>setMainLinks</code> can accept single-language or multi-language links:</p>
|
|
99
|
-
<pre><code class="typescript"><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">singleLanguageLink</span><span class="hl-2">: </span><span class="hl-13">Translatable</span><span class="hl-2"><</span><span class="hl-13">MainLink</span><span class="hl-2">> = {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Home'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://www.example.com'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-12">multiLanguageLink</span><span class="hl-2">: </span><span class="hl-13">Translatable</span><span class="hl-2"><</span><span class="hl-13">MainLink</span><span class="hl-2">> = {</span><br/><span class="hl-2"> </span><span class="hl-6">nl:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Startpagina'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://www.example.com/nl'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-6">en:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Home'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://www.example.com/en'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-6">fr:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Accueil'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://www.example.com/fr'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-6">de:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">label:</span><span class="hl-2"> </span><span class="hl-9">'Startseite'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">href:</span><span class="hl-2"> </span><span class="hl-9">'https://www.example.com/de'</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-6">client</span><span class="hl-2">.</span><span class="hl-7">setMainLinks</span><span class="hl-2">([</span><span class="hl-6">singleLanguageLink</span><span class="hl-2">]);</span><br/><span class="hl-8">// or</span><br/><span class="hl-6">client</span><span class="hl-2">.</span><span class="hl-7">setMainLinks</span><span class="hl-2">([</span><span class="hl-6">multiLanguageLink</span><span class="hl-2">]);</span>
|
|
100
|
-
</code><button type="button">Copy</button></pre>
|
|
101
|
-
|
|
102
96
|
<a id="md:browser-support" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Browser Support<a href="#md:browser-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <strong>Global Header Widget</strong> supports the two most recent versions of all major browsers:</p>
|
|
103
97
|
<ul>
|
|
104
98
|
<li>Google Chrome</li>
|
|
@@ -115,4 +109,4 @@ Action Required:</p>
|
|
|
115
109
|
<a id="md:maintainers" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Maintainers<a href="#md:maintainers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
116
110
|
<li><a href="https://github.com/m44rten1" target="_blank" class="external">Maarten Van Steenkiste</a></li>
|
|
117
111
|
</ul>
|
|
118
|
-
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:adding-a-flanders-global-header-to-your-website"><span>Adding a <wbr/>Flanders <wbr/>Global <wbr/>Header to <wbr/>Your <wbr/>Website</span></a><ul><li><a href="#md:
|
|
112
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:adding-a-flanders-global-header-to-your-website"><span>Adding a <wbr/>Flanders <wbr/>Global <wbr/>Header to <wbr/>Your <wbr/>Website</span></a><ul><li><a href="#md:using-the-entry-script"><span>Using the <wbr/>Entry <wbr/>Script</span></a></li><li><a href="#md:using-the-embed-script"><span>Using the <wbr/>Embed <wbr/>Script</span></a></li><li><a href="#md:summary"><span>Summary</span></a></li></ul><a href="#md:installation"><span>Installation</span></a><a href="#md:usage"><span>Usage</span></a><a href="#md:migration-guide-upgrading-from-v4-to-v5"><span>Migration guide: <wbr/>Upgrading from v4 to v5</span></a><ul><li><a href="#md:remove-client-library-script-links"><span>Remove client library script links</span></a></li><li><a href="#md:eliminate-installable-packages"><span>Eliminate installable packages</span></a></li><li><a href="#md:update-embed-script-links"><span>Update <wbr/>Embed script links</span></a></li><li><a href="#md:update-api-usage"><span>Update API usage</span></a></li><li><a href="#md:accessing-windowglobalheaderclient"><span>Accessing window.global<wbr/>Header<wbr/>Client</span></a></li><li><a href="#md:verify-styling-and-rendering"><span>Verify <wbr/>Styling and <wbr/>Rendering</span></a></li></ul><a href="#md:language-switching"><span>Language <wbr/>Switching</span></a><a href="#md:browser-support"><span>Browser <wbr/>Support</span></a><a href="#md:contact-information"><span>Contact <wbr/>Information</span></a><a href="#md:maintainers"><span>Maintainers</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Global Header Client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccessMenuConfig | Global Header Client</title><meta name="description" content="Documentation for Global Header Client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header Client</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 Client</a></li><li><a href="AccessMenuConfig.html">AccessMenuConfig</a></li></ul><h1>Interface AccessMenuConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AccessMenuConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#application">application</a><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-interface">Application</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#applicationMenu">applicationMenu</a><span class="tsd-signature-symbol">?: </span><a href="ApplicationLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationLink</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#mainLinks">mainLinks</a><span class="tsd-signature-symbol">?: </span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#pluginTypeId">pluginTypeId</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"citizen_profile"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#session">session</a><span class="tsd-signature-symbol">: </span><a href="Session.html" class="tsd-signature-type tsd-kind-interface">Session</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/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccessMenuConfig | Global Header Client</title><meta name="description" content="Documentation for Global Header Client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header Client</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 Client</a></li><li><a href="AccessMenuConfig.html">AccessMenuConfig</a></li></ul><h1>Interface AccessMenuConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AccessMenuConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#application">application</a><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-interface">Application</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#applicationMenu">applicationMenu</a><span class="tsd-signature-symbol">?: </span><a href="ApplicationLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationLink</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#mainLinks">mainLinks</a><span class="tsd-signature-symbol">?: </span><a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#pluginTypeId">pluginTypeId</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"citizen_profile"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AccessMenuConfig.html#session">session</a><span class="tsd-signature-symbol">: </span><a href="Session.html" class="tsd-signature-type tsd-kind-interface">Session</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/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/access-menu.ts#lines-54">global-header-types/src/access-menu.ts:54</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="AccessMenuConfig.html#application" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>application</span></a>
|
|
2
2
|
<a href="AccessMenuConfig.html#applicationMenu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>application<wbr/>Menu?</span></a>
|
|
3
3
|
<a href="AccessMenuConfig.html#mainLinks" 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/>Links?</span></a>
|
|
4
4
|
<a href="AccessMenuConfig.html#pluginTypeId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>plugin<wbr/>Type<wbr/>Id</span></a>
|
|
5
5
|
<a href="AccessMenuConfig.html#session" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session</span></a>
|
|
6
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="application" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>application</span><a href="#application" 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">application</span><span class="tsd-signature-symbol">:</span> <a href="Application.html" class="tsd-signature-type tsd-kind-interface">Application</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
6
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="application" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>application</span><a href="#application" 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">application</span><span class="tsd-signature-symbol">:</span> <a href="Application.html" class="tsd-signature-type tsd-kind-interface">Application</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/access-menu.ts#lines-57">global-header-types/src/access-menu.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="applicationMenu" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>application<wbr/>Menu</span><a href="#applicationMenu" 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">application<wbr/>Menu</span><span class="tsd-signature-symbol">?:</span> <a href="ApplicationLink.html" class="tsd-signature-type tsd-kind-interface">ApplicationLink</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/access-menu.ts#lines-58">global-header-types/src/access-menu.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mainLinks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>main<wbr/>Links</span><a href="#mainLinks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">main<wbr/>Links</span><span class="tsd-signature-symbol">?:</span> <a href="MainLink.html" class="tsd-signature-type tsd-kind-interface">MainLink</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/access-menu.ts#lines-59">global-header-types/src/access-menu.ts:59</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pluginTypeId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>plugin<wbr/>Type<wbr/>Id</span><a href="#pluginTypeId" 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">plugin<wbr/>Type<wbr/>Id</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/access-menu.ts#lines-55">global-header-types/src/access-menu.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="session" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>session</span><a href="#session" 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">session</span><span class="tsd-signature-symbol">:</span> <a href="Session.html" class="tsd-signature-type tsd-kind-interface">Session</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/access-menu.ts#lines-56">global-header-types/src/access-menu.ts:56</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#application" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>application</span></a><a href="#applicationMenu" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>application<wbr/>Menu</span></a><a href="#mainLinks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main<wbr/>Links</span></a><a href="#pluginTypeId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>plugin<wbr/>Type<wbr/>Id</span></a><a href="#session" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Global Header Client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AlertConfig | Global Header Client</title><meta name="description" content="Documentation for Global Header Client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Global Header Client</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 Client</a></li><li><a href="AlertConfig.html">AlertConfig</a></li></ul><h1>Interface AlertConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the configuration for the alert bar displayed on top of the header widget.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AlertConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#modifier">modifier</a><span class="tsd-signature-symbol">: </span><a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AlertConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="AlertConfig.html#modifier">modifier</a><span class="tsd-signature-symbol">: </span><a href="../types/AlertModifier.html" class="tsd-signature-type tsd-kind-type-alias">AlertModifier</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://bitbucket.org/vlaamseoverheid/vl-widgets/src/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/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/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/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/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/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/a4fd6880557956bbd2ec39e69311d30ed2bfb23f/packages/global-header-types/src/alert.ts#lines-20">global-header-types/src/alert.ts:20</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#enabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#modifier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modifier</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Global Header Client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
|