@ebrains/components 0.3.0-alpha.0 → 0.5.0-alpha.0

package/dist/types/shared-ui/eds-card-section/eds-card-section.d.ts

@@ -1,3 +1,30 @@
+export interface Tag {
+    label: string;
+    style: 'accent' | 'default' | 'weak' | 'strong';
+}
+export interface CardImage {
+    src: string;
+    alt: string;
+    srcset?: string;
+    sizes?: string;
+    width?: number;
+    height?: number;
+    lazyload?: boolean;
+}
+export interface Card {
+    title: string;
+    url?: string;
+    description?: string;
+    image?: CardImage | string;
+    avatar?: string;
+    shortAbbreviation?: string;
+    headingLevel?: string;
+    tags?: string | Tag[];
+    tiny?: boolean;
+    bg?: boolean;
+    withHover?: boolean;
+    hierarchy?: boolean;
+}
 /**
  * `EdsCardSection` is a component that renders a section of cards in a customizable grid layout.
  * Each card within the section can display various properties such as title, description, avatar, and additional content.
@@ -18,12 +45,7 @@ export declare class EdsCardSection {
      * '[{"title": "Card Title", "description": "Description", "avatar": "/path/to/avatar.jpg", "url": "http://example.com"}]'
      * ```
      */
-    cards: string | {
-        title: string;
-        description: string;
-        tags: string;
-        url: string;
-    }[];
+    cards: string | Card[];
     /**
      * Number of columns to span for each card in the grid layout.
      * This value sets the column span on medium (md) and larger screen sizes.

package/dist/types/shared-ui/eds-card-section/eds-card-section.stories.d.ts

@@ -21,32 +21,53 @@ declare const _default: {
         };
     };
     args: {
-        cards: string;
-        cols: number;
-        extraClass: string;
-    };
-    parameters: {};
-};
-export default _default;
-export declare const WithString: {
-    render: (args: any) => string;
-};
-export declare const WithObject: {
-    render: (args: any) => HTMLEdsCardSectionElement;
-    args: {
-        cards: {
+        cards: ({
             title: string;
             description: string;
+            url: string;
+            avatar: string;
+            shortAbbreviation: string;
+            headingLevel: string;
             tags: string;
+            tiny: boolean;
+            bg: boolean;
+            withHover: boolean;
+            image: {
+                src: string;
+                alt: string;
+                srcset: string;
+                sizes: string;
+                width: number;
+                height: number;
+                lazyload: boolean;
+            };
+        } | {
+            title: string;
+            description: string;
             url: string;
-        }[];
+            avatar: string;
+            shortAbbreviation: string;
+            headingLevel: string;
+            tags: string;
+            tiny: boolean;
+            bg: boolean;
+            withHover: boolean;
+            image: {
+                src: string;
+                alt: string;
+                width: number;
+                height: number;
+                lazyload: boolean;
+                srcset?: undefined;
+                sizes?: undefined;
+            };
+        })[];
         cols: number;
         extraClass: string;
     };
-    argTypes: {
-        cards: {
-            control: string;
-            description: string;
-        };
-    };
+    parameters: {};
+};
+export default _default;
+export declare const Default: {
+    render: (args: any) => HTMLEdsCardSectionElement;
 };

package/dist/types/shared-ui/eds-header/eds-header.d.ts

@@ -33,32 +33,12 @@ export declare class EdsHeader {
      * When true, the header applies styles suitable for a dark background.
      */
     inverseHeader: boolean;
-    /**
-     * Flag to enable or disable user authentication features.
-     * When true, displays the authentication options in the header.
-     */
-    userFeature: boolean;
     /**
      * Flag to enable or disable header menu toggle feature.
      * When true, displays the toggle in the header.
      * Requires the <eds-fullscreen-menu> to properly work.
      */
     menuEnabled: boolean;
-    /**
-     * The URL of the Keycloak server.
-     * Required if `userFeature` is enabled.
-     */
-    keycloakUrl: string;
-    /**
-     * The Keycloak Realm for authentication.
-     * Required if `userFeature` is enabled.
-     */
-    keycloakRealm: string;
-    /**
-     * The Keycloak Client ID for the application.
-     * Required if `userFeature` is enabled.
-     */
-    keycloakClientId: string;
     /**
      * State indicating whether the main menu is open.
      * Controls the visibility of the fullscreen main menu.

package/dist/types/shared-ui/eds-login/eds-login.d.ts

@@ -1,16 +1,8 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-/**
- * `EdsLogin` is a login component that integrates Keycloak authentication,
- * allowing users to log in and out and manage authentication states.
- * This component is used to handle user login, logout, and authentication status display.
- *
- * This component is ideal for applications that require Keycloak-based authentication,
- * providing a simple login/logout interface and managing user session states.
- */
 export declare class EdsLogin {
     /**
      * The URL of the Keycloak server.
-     * This is the base URL where your Keycloak instance is hosted,
+     * This is the base URL where your Keycloak instance is hosted.
      */
     keycloakUrl: string;
     /**
@@ -28,23 +20,34 @@ export declare class EdsLogin {
      */
     keycloakClientId: string;
     authenticated: boolean;
-    /**
-     * The user object containing user information.
-     * This is populated after a successful authentication.
-     */
     user: any;
     /**
      * Event emitted when the authentication status changes.
-     * It emits a boolean value indicating the new authentication status.
      */
     authStatusChanged: EventEmitter<{
         authenticated: boolean;
         user: any;
     }>;
+    /**
+     * Lifecycle method that runs when the component is about to load.
+     * It initializes authentication by calling the `initAuth` method.
+     */
     componentWillLoad(): Promise<void>;
-    checkAuthentication(): Promise<void>;
-    handleLogin(): Promise<void>;
-    handleLogout: () => void;
-    getBtnLabel(): string;
+    /**
+     * Initializes the Keycloak authentication by configuring Keycloak with the provided props.
+     * Sets the `authenticated` state and `user` data if the user is authenticated.
+     * Emits `authStatusChanged` event with the authentication status.
+     */
+    initAuth(): Promise<void>;
+    /**
+     * Handles user login by invoking the Keycloak `login` function.
+     * Only triggers login if the user is not already authenticated.
+     */
+    handleLogin: () => Promise<void>;
+    /**
+     * Handles user logout by invoking the Keycloak `logout` function.
+     * Resets the `authenticated` state to `false` after logout.
+     */
+    handleLogout: () => Promise<void>;
     render(): any;
 }

package/dist/types/shared-ui/eds-user/eds-user.d.ts

@@ -37,15 +37,15 @@ export declare class EdsUser {
      * This is set to `true` if the user is successfully authenticated with Keycloak.
      */
     authenticated: boolean;
-    /**
-     * Indicates whether the Keycloak server is available.
-     */
-    serverAvailable: boolean;
     /**
      * The username of the authenticated user.
      * This is extracted from the `user` object after successful authentication.
      */
     username: string;
+    /**
+     * Indicates whether the Keycloak server is available.
+     */
+    serverAvailable: boolean;
     /**
      * Event emitted when the authentication status changes.
      * It emits an object {authenticated, user} indicating the new authentication status and the user's information.
@@ -75,6 +75,6 @@ export declare class EdsUser {
      * Handles user logout by invoking the Keycloak `logout` function.
      * Resets the `authenticated` state to `false` after logout.
      */
-    handleLogout: () => void;
+    handleLogout: () => Promise<void>;
     render(): any;
 }

package/dist/types/utils/global.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/keycloak.d.ts

@@ -12,8 +12,8 @@ export declare function getUser(): {
     firstname: any;
     username: any;
     background: string;
-    token: any;
-    sub: any;
+    token: string;
+    sub: string;
 } | {
     fullname?: undefined;
     email?: undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ebrains/components",
-  "version": "0.3.0-alpha.0",
+  "version": "0.5.0-alpha.0",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.js",
   "es2015": "./dist/esm/index.mjs",

package/dist/cjs/color-3ffe3072.js

@@ -1,342 +0,0 @@
-'use strict';
-
-const index = require('./index-ab9fbefe.js');
-
-[
-    ['eds-header', {
-            'home-url': '/',
-            'user-feature': 'false',
-            'keycloak-url': 'http://localhost:8080',
-            'keycloak-realm': 'nigeor-realm',
-            'keycloak-client-id': 'stencil-app',
-            links: JSON.stringify([
-                { label: 'About', url: '/about' },
-                { label: 'Focus Areas', url: '/focus-areas' },
-                { label: 'News & Events', url: '/news-and-events' },
-                { label: 'Contact', url: '/contact' },
-            ]),
-        }],
-    ['eds-block-break', {}],
-    ['eds-footer', {}],
-    ['eds-block-break', {}],
-    ['eds-tabs', {
-            tabs: JSON.stringify([
-                { label: 'Home', url: '#', active: true, ariaLabel: 'Home Tab' },
-                { label: 'Profile', url: '#', active: false, ariaLabel: 'Profile Tab' },
-                { label: 'Settings', url: '#', active: false, ariaLabel: 'Settings Tab' },
-            ]),
-        }],
-    ['eds-block-break', {}],
-    ['eds-card-section', {
-            cards: JSON.stringify([
-                { title: 'Card 1', description: 'Description 1', tags: 'tag1, tag2', url: '/link1' },
-                { title: 'Card 2', description: 'Description 2', tags: 'tag3', url: '/link2' },
-            ]),
-            cols: '4',
-        }],
-    ['eds-block-break', {}],
-    ['eds-link', {
-            label: 'Main Link Click Me',
-            url: 'https://example.com',
-            intent: 'primary'
-        }],
-    ['eds-block-break', {}],
-    ['eds-avatar', { 'first-name': 'John', 'last-name': 'Doe' }],
-    ['eds-block-break', {}],
-    ['eds-breadcrumb', {
-            items: JSON.stringify([
-                { label: 'Home', url: '/' },
-                { label: 'Products', url: '/products' },
-                { label: 'Electronics', url: '/products/electronics' },
-                { label: 'Laptops', url: '/products/electronics/laptops' },
-            ]),
-            intent: 'primary',
-        }],
-    ['eds-block-break', {}],
-    ['eds-card-generic', {
-            'card-title': 'The Future of AI in Healthcare',
-            url: 'https://example.com/ai-healthcare',
-            description: 'Explore how AI is transforming the healthcare industry with cutting-edge technologies and research.',
-            avatar: 'https://files.ebrains.eu/img/686e0edc-f3be-4d79-aa02-373c32c08d65/ebrains-logo-high-resolution.png?fit=max&q=80&fm=webp&crop=879%2C879%2C597%2C0&w=200',
-            'short-abbreviation': 'AI',
-            'heading-level': 'h2',
-            tags: 'Technology,AI,Healthcare',
-            tiny: 'false',
-            bg: 'true',
-            'with-hover': 'true',
-        }],
-    ['eds-block-break', {}],
-    ['eds-code-block', {
-            code: 'Hello',
-            language: 'javascript',
-        }],
-    ['eds-block-break', {}],
-    ['eds-dropdown', {
-            'aria-label': 'More options',
-            'rounded-btn': 'true',
-            'dropdown-pos': 'right',
-            'dropdown-offset': 'true',
-        }],
-    ['eds-block-break', {}],
-    ['eds-form', {
-            name: 'extended-form',
-            endpoint: 'http://127.0.0.1:5000/api/data',
-            fields: JSON.stringify([
-                { name: 'username', label: 'Username', type: 'text', required: true, maxlength: 10 },
-                { name: 'email', label: 'Email', type: 'email', required: true },
-                { name: 'number', label: 'Number', type: 'number', required: true },
-                { name: 'password', label: 'Password', type: 'password', required: true, maxlength: 50 },
-                { name: 'date', label: 'Date', type: 'date', required: true },
-                { name: 'file', label: 'File', type: 'file', required: false },
-                { name: 'hiddenField', type: 'hidden', value: 'hiddenValue' },
-                { name: 'bio', label: 'Biography', type: 'textarea', required: true, maxlength: 300 },
-                { name: 'role', label: 'Role', type: 'select', required: true, options: [
-                        { label: 'Admin', value: 'admin' },
-                        { label: 'Editor', value: 'editor' },
-                        { label: 'Viewer', value: 'viewer' },
-                    ] },
-                { name: 'preferences', type: 'checkbox', label: 'Select your preferences', options: [
-                        { value: 'option1', label: 'Option 1' },
-                        { value: 'option2', label: 'Option 2' },
-                        { value: 'option3', label: 'Option 3' },
-                    ], required: true },
-                { name: 'gender', type: 'radio', label: 'Select your gender', options: [
-                        { value: 'female', label: 'Female' },
-                        { value: 'male', label: 'Male' },
-                    ], required: true },
-                { name: 'newsletter', label: 'newsletter', type: 'checkbox', value: 'subscribe', required: true },
-                { name: 'range', label: 'Range bar', type: 'range', min: '0', max: '10', step: '1', required: true },
-            ]),
-            'success-message': 'Form submitted successfully!',
-            'error-message': 'Please fix the errors in the form.',
-            'submit-btn': 'true',
-            'small-alert': 'false',
-            'set-form-url': 'true',
-        }],
-    ['eds-block-break', {}],
-    ['eds-img', {
-            src: 'https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.jpg',
-            alt: 'EBRAINS Bernstein Conference',
-            width: '400',
-            height: '225',
-            srcset: 'https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.jpg 720w, https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.jpg 1080w, https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.jpg 1440w',
-            sizes: '(max-width: 600px) 100vw, (max-width: 1200px) 50vw, 33vw',
-            formats: JSON.stringify([
-                { type: 'image/webp', srcset: 'https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.webp 720w, https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.webp 1080w' },
-                { type: 'image/jpeg', srcset: 'https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.jpg 720w, https://files.ebrains.eu/img/f999348c-beaa-40f8-ba60-230316d4a947/EBRAINS-BernsteinConference01.jpg 1080w' },
-            ]),
-            lazyload: 'true',
-            'with-bg': 'true',
-        }],
-    ['eds-block-break', {}],
-    ['eds-input-field', {
-            name: 'username',
-            'input-id': 'username',
-            label: 'Username',
-            placeholder: 'Enter your username',
-            required: 'true',
-            hint: 'Your unique username',
-            message: 'This field is required',
-            'error-message': 'Invalid username',
-            type: 'text',
-        }],
-    ['eds-block-break', {}],
-    ['eds-pagination', {
-            'current-page': '1',
-            'last-page': '10',
-            'per-page': '5',
-            total: '50',
-            mode: 'default',
-        }],
-    ['eds-block-break', {}],
-    ['eds-progress-bar', { value: '75' }],
-    ['eds-table', {
-            data: JSON.stringify([
-                { Property: 'username', Type: 'string', Required: 'Yes' },
-                { Property: 'password', Type: 'string', Required: 'Yes' },
-                { Property: 'email', Type: 'string', Required: 'No' },
-            ]),
-            config: JSON.stringify({
-                Type: { format: 'uppercase' },
-                Property: { format: 'code' },
-                Required: { hidden: true },
-            }),
-        }],
-    ['eds-block-break', {}],
-    ['eds-tag', { label: 'Default Tag', intent: 'default' }],
-];
-
-// Helper function to check if Matomo is initialized
-function isMatomoAvailable() {
-    return typeof window !== 'undefined' && typeof window._paq !== 'undefined';
-}
-// General function to push data to Matomo
-function pushToMatomo(action, ...args) {
-    console.log('Pushing Matomo');
-    if (isMatomoAvailable()) {
-        window._paq.push([action, ...args]);
-    }
-    else {
-        console.warn('Matomo is not available or not initialized.');
-    }
-}
-// Function to send analytics data
-function sendAnalytics(eventData) {
-    var _a;
-    if (!isMatomoAvailable()) {
-        console.warn('Matomo is not available or not initialized.');
-        console.log(Object.assign({}, eventData));
-        return;
-    }
-    // Conditionally build the name field
-    const nameParts = [];
-    if ((_a = eventData.parentContext) === null || _a === void 0 ? void 0 : _a.componentName) {
-        nameParts.push(eventData.parentContext.componentName);
-    }
-    nameParts.push(eventData.tag || 'unknown-tag');
-    nameParts.push(eventData.name || 'unknown-name');
-    const name = nameParts.join('/');
-    //console.log('trackEvent', eventData.category, eventData.action, name)
-    pushToMatomo('trackEvent', eventData.category, eventData.action, name);
-    console.log(Object.assign({}, eventData));
-}
-// Function to opt-in the user
-function matomoOptIn() {
-    if (isMatomoAvailable()) {
-        window._paq.push(['rememberConsentGiven']);
-        console.log('User has opted in to tracking');
-    }
-}
-
-const GRADIANT_TOKENS = ['green', 'yellow', 'among-blue', 'purple'];
-const gradientBGColorVariants = index.cva([], {
-    variants: {
-        color: GRADIANT_TOKENS.reduce((acc, token) => (Object.assign(Object.assign({}, acc), { [token]: '' })), {}),
-        direction: {
-            top: '',
-            bottom: ''
-        },
-        pseudo: {
-            true: 'before:effect-opacity effect-bg-behind',
-            false: ''
-        },
-        hover: {
-            true: 'before:opacity-0 hover:before:opacity-100',
-            false: ''
-        }
-    },
-    compoundVariants: [
-        // region GREEN
-        {
-            color: 'green',
-            direction: 'top',
-            pseudo: true,
-            className: 'before:bg-gradient-01-top'
-        },
-        {
-            color: 'green',
-            pseudo: true,
-            direction: 'bottom',
-            className: 'before:bg-gradient-01-bottom'
-        },
-        {
-            color: 'green',
-            direction: 'top',
-            pseudo: false,
-            className: 'bg-gradient-01-top'
-        },
-        {
-            color: 'green',
-            pseudo: false,
-            direction: 'bottom',
-            className: 'bg-gradient-01-bottom'
-        },
-        // endregion
-        // region YELLOW
-        {
-            color: 'yellow',
-            direction: 'top',
-            pseudo: true,
-            className: 'before:bg-gradient-02-top'
-        },
-        {
-            color: 'yellow',
-            direction: 'bottom',
-            pseudo: true,
-            className: 'before:bg-gradient-02-bottom'
-        },
-        {
-            color: 'yellow',
-            direction: 'top',
-            pseudo: false,
-            className: 'bg-gradient-02-top'
-        },
-        {
-            color: 'yellow',
-            direction: 'bottom',
-            pseudo: false,
-            className: 'bg-gradient-02-bottom'
-        },
-        // endregion
-        // region PURPLE
-        {
-            color: 'purple',
-            direction: 'top',
-            pseudo: true,
-            class: 'before:bg-gradient-03-top'
-        },
-        {
-            color: 'purple',
-            direction: 'bottom',
-            pseudo: true,
-            class: 'before:bg-gradient-03-bottom'
-        },
-        {
-            color: 'purple',
-            direction: 'top',
-            pseudo: false,
-            class: 'bg-gradient-03-top'
-        },
-        {
-            color: 'purple',
-            direction: 'bottom',
-            pseudo: false,
-            class: 'bg-gradient-03-bottom'
-        },
-        // endregion
-        // region AMONG-BLUE
-        {
-            color: 'among-blue',
-            direction: 'top',
-            pseudo: true,
-            class: 'before:bg-gradient-04-top'
-        },
-        {
-            color: 'among-blue',
-            direction: 'bottom',
-            pseudo: true,
-            class: 'before:bg-gradient-04-bottom'
-        },
-        {
-            color: 'among-blue',
-            direction: 'top',
-            pseudo: false,
-            class: 'bg-gradient-04-top'
-        },
-        {
-            color: 'among-blue',
-            direction: 'bottom',
-            pseudo: false,
-            class: 'bg-gradient-04-bottom'
-        }
-        // endregion
-    ],
-    defaultVariants: {
-        direction: 'top',
-        pseudo: true
-    }
-});
-
-exports.gradientBGColorVariants = gradientBGColorVariants;
-exports.matomoOptIn = matomoOptIn;
-exports.sendAnalytics = sendAnalytics;