@govflanders/vl-widget-global-header-types 1.0.29 → 1.0.30
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 +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -229,7 +229,7 @@ The `mount` method allows you to control where the **Global Header Widget** is r
|
|
|
229
229
|
<script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/__global_header_id__/embed"></script>
|
|
230
230
|
```
|
|
231
231
|
|
|
232
|
-
The widget will **automatically render** at the location where the script is placed in the HTML. No additional action is needed to mount the widget in this case.
|
|
232
|
+
The widget will **automatically render** as a `<div>` at the location where the script is placed in the HTML. No additional action is needed to mount the widget in this case. For accessibility reasons, the header is marked with `role="banner"`. If you prefer not to include this role (e.g., to avoid multiple banner roles on a page), use the mount method described above with a `<div>` element.
|
|
233
233
|
|
|
234
234
|
#### Return Value
|
|
235
235
|
|
|
@@ -264,7 +264,7 @@ Version Update in Embed Links: If you’re using the embed script method to incl
|
|
|
264
264
|
|
|
265
265
|
### 4. Update API usage
|
|
266
266
|
|
|
267
|
-
API Changes: The globalHeaderClient API has been updated in version 5. Methods, their signatures, and usage patterns may have changed. Refer to the API section for detailed information on the new methods and their parameters.
|
|
267
|
+
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.
|
|
268
268
|
|
|
269
269
|
Action Required:
|
|
270
270
|
- Review all instances where you interact with globalHeaderClient.
|