@govflanders/vl-widget-global-header-types

v2.0.2

Published

6 days ago

TypeScript definitions for GlobalHeaderClient

Downloads

309

Introduction

This guide is for developers looking to integrate the Flanders Global Header into their websites.

Adding a Flanders Global Header to Your Website

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.

💡 Note: the embed url differs from the previous one. Now it's api/v2 instead of api/v1.

Using the Embed Script (Automatic Mounting)

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.

Example of using the embed script:

<!DOCTYPE html>
<html lang="nl">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Global header embed script example</title>
  </head>
  <body>
    <script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/9717ae3b-84e8-43b2-a814-e35a2547927f/embed"></script>
    <div class="your-website-code">👋 Hello world</div>
  </body>
</html>

⚠️ Warning: the window.globalHeaderClient object will only be available after the scrip is resolved. If it's necessary to have direct access to the window.globalHeaderClient, use the entry script.

Using the Entry Script (Manual Mounting)

Use the entry script if you need more control over when, where and how the header is mounted. The entry script should be placed in the <head> section of your HTML, preferably at the top. This is essential because the window.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.

Example of using the entry script:

<!DOCTYPE html>
<html lang="nl">
  <head>
    <script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/9717ae3b-84e8-43b2-a814-e35a2547927f/entry"></script>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Global header entry script example</title>
  </head>
  <body>
    <div class="your-website-code">👋 Hello world</div>
    <script>
      window.globalHeaderClient.mount(); // Mount the header manually after the script has loaded
    </script>
  </body>
</html>

Summary

Entry script: Use in the <head>, requires manual mounting with window.globalHeaderClient.mount() method.
Embed script: Place directly in the DOM, automatically renders the header at the script's location.

Using the `window.globalHeaderClient` API

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, if you're using typescript (more info here).

Example of using the window.globalHeaderClient object in javascript:

const client = window.globalHeaderClient;

const contactLink = {
  label: 'Contact',
  href: '/contact',
};

const feedbackLink = {
  label: 'Feedback',
  href: 'https://example.com/feedback',
  isExternal: true,
  target: '_blank',
};

client.accessMenu.setMainLinks([
  contactLink,
  feedbackLink,
]);

Checkout the GlobalHeaderClient here to see all the available methods.

Migration guide: Upgrading from v4 to v5

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.

Remove client library script links

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 (after the script is loaded). Action Required:

Remove any <script> tags that reference client libraries or polyfill libraries for the widget.
Ensure that either the entry script or the embed script is included in your HTML.

Eliminate installable packages

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.

Action Required:

Uninstall any npm or yarn packages related to the widget
Delete any import or require statements in your JavaScript code that reference the widget.

Update Embed script links

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.

Update API usage

API Changes: The window.globalHeaderClient API has been updated in version 5. Methods, their signatures, and usage patterns may have changed. Refer to the GlobalHeaderClient section for detailed information on the new methods and their parameters.

Action Required:

Review all instances where you interact with window.globalHeaderClient.
Update your code to align with the new GlobalHeaderClient methods and their signatures.
Pay special attention to asynchronous methods that now return promises.

Example:

// Using widgets V4
- vl.widget.client.capture(
-   // Verplichte capture functie.
-   function(widget) {
-     if (widget.getPluginTypeId() === 'global_header') {
-       widget.getExtension('contact', 'unsafe').resetServicePoints();
-     }
-   },
- );
// Using widgets V5
+ globalHeaderClient.contact.resetServicePoints();

Accessing `window.globalHeaderClient`

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.

Action Required:

Ensure that you include either the entry script or the embed script in your HTML.
Remove any additional scripts previously used to access window.globalHeaderClient.

Verify Styling and Rendering

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.

Action Required:

Test Across Browsers: Check the widget in all supported browsers to confirm consistent styling and behavior.
Inspect for Conflicts: Look for any CSS conflicts between the widget and your site’s stylesheets.
Adjust Styles if Needed: Modify your CSS or override styles to resolve any layout or design issues.
Seek Assistance: If problems persist, don’t hesitate to contact us for support.

Language Switching

The Global Header Widget v5 now supports multiple languages. 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.

Supported languages:

nl (Dutch)
fr (French)
de (German)
en (English)

To change the document language, you can use the following JavaScript snippet:

window.document.documentElement.lang = 'nl'; // 'nl', 'en', 'de' or 'fr'

This will switch the document's language to Dutch, and the widget will automatically reflect the change.

Notes:

When using a multilingual widget, ensure its configuration also supports multiple languages.
Lang tag variants are also handled correctly (for example, like NL or nl-BE)
Take a look at the documentation for multilingual objects here.

Browser Support

The Global Header Widget supports the two most recent versions of all major browsers:

Google Chrome
Mozilla Firefox
Microsoft Edge
Safari

Please ensure your users are on the latest versions of these browsers to guarantee full functionality of the widget.

Typescript Support

The @govflanders/vl-widget-global-header-types package provides TypeScript types and interfaces for interacting with the Global Header Widget. This widget is embedded in customer web pages and exposes a client object (window.globalHeaderClient) that allows for dynamic configuration and interaction with the global header.

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.

Installation

To install the global-header-types package, use the following command:

npm install -D @govflanders/vl-widget-global-header-types

yarn add -D @govflanders/vl-widget-global-header-types

Note: It’s recommended to use the caret (^) symbol in your package.json to stay updated with the latest minor and patch versions.

Usage example

Example of using the types to interact with the widget:

import { GlobalHeaderClient, MainLink } from '@govflanders/vl-widget-global-header-types';

const client: GlobalHeaderClient = window.globalHeaderClient;

const contactLink: MainLink = {
  label: 'Contact',
  href: '/contact',
};

const feedbackLink: MainLink = {
  label: 'Feedback',
  href: 'https://example.com/feedback',
  isExternal: true,
  target: '_blank',
};

client.accessMenu.setMainLinks([
  contactLink,
  feedbackLink,
]);

Contact Information

If you need assistance or have any questions regarding the Global Header Widget, feel free to reach out to us:

Support Portal: Widget platform

Our team is here to help with any issues or inquiries you might have.

Search Keywords

Global Header Integration
Flanders Widget Setup
Flanders Global Header
V5 Widget Migration
GlobalHeaderClient API
Embed Script Example
Entry Script Mounting
Multilingual Global Header
Language Switching in Widgets
Widget Browser Support
Global Header JavaScript API
Dynamic Header Links
TypeScript Widget Integration
Flanders Widget API Usage
V4 to V5 Migration Guide

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Introduction

Adding a Flanders Global Header to Your Website

Using the Embed Script (Automatic Mounting)

Using the Entry Script (Manual Mounting)

Summary

Using the window.globalHeaderClient API

Migration guide: Upgrading from v4 to v5

Remove client library script links

Eliminate installable packages

Update Embed script links

Update API usage

Accessing window.globalHeaderClient

Verify Styling and Rendering

Language Switching

Browser Support

Typescript Support

Installation

Usage example

Contact Information

Search Keywords

Using the `window.globalHeaderClient` API

Accessing `window.globalHeaderClient`