@x4b/webcomponent-banner 28.4.0

package/README.MD

@@ -0,0 +1,58 @@
+# X4B Webcomponent Banner
+
+This project provides a webcomponent component for the banner
+
+## Install
+
+-   Install the banner package
+
+```sh
+npm install @x4b/webcomponent-banner
+# or
+yarn add @x4b/webcomponent-banner
+```
+
+-   Install the fonts
+
+By default, the banner uses the open sans font.
+In the head of the HTML file, add the following code:
+
+```html
+<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;500;600&display=swap" />
+```
+
+## Example
+
+First, you have to register the webcomponent:
+
+```javascript
+import { register } from './library';
+
+register();
+
+```
+Add the webcomponent to your application:
+
+```javascript
+<x4b-banner
+    apps-service-url="https://x4b.dev.xcomponent.com/apps"
+    notification-count="3"
+    application="scenario"
+    version="dev-test"
+    language="en"
+    languages="en,fr"
+></x4b-banner>
+
+```
+
+You can listen to the following DOM events:
+
+| Event                       | Description                                       | Parameter                                        |
+| --------------------------- | ------------------------------------------------- | ------------------------------------------------ |
+| `languageChanged`           | Triggered when a language is selected             | Selected language                                |
+| `menuToggleButtonClicked`   | Triggered when the burger button is clicked       | Menu state (true -> full size, false -> reduced) |
+| `notificationButtonClicked` | Triggered when the notification button is clicked | None                                             |
+| `tokenRefreshed`            | Triggered when the token is refreshed             | None                                             |
+| `startupFinished`           | Triggered when the banner is initialized          | None                                             |
+
+

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './library/index'

package/dist/library/BannerWebcomponent.d.ts

@@ -0,0 +1,9 @@
+import { Root } from 'react-dom/client';
+export declare class BannerWebcomponent extends HTMLElement {
+    protected root?: Root;
+    static get observedAttributes(): string[];
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected renderReactApp(): void;
+    protected attributeChangedCallback(): void;
+}

package/dist/library/index.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+declare type BannerProps = {
+    'notification-count'?: string;
+    application: string;
+    language: string;
+    languages: string;
+    version: string;
+    'apps-service-url': string;
+};
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            'x4b-banner': React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> & BannerProps;
+        }
+    }
+}
+export declare function register(): void;
+export { getDefaultLanguage, getToken, isMenuOpen } from '@x4b/banner';

package/dist/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>