@siemens/element-ng 47.9.0 → 48.0.0-next.2

package/about/index.d.ts

@@ -1,7 +1,131 @@
+import * as _angular_platform_browser from '@angular/platform-browser';
+import * as _angular_core from '@angular/core';
+import { OnInit } from '@angular/core';
+import { CopyrightDetails } from '@siemens/element-ng/copyright-notice';
+import { Link } from '@siemens/element-ng/link';
+
 /**
  * Copyright (c) Siemens 2016 - 2025
  * SPDX-License-Identifier: MIT
  */
-export * from './si-about.component';
-export * from './si-about.module';
-export * from './si-about-data.model';
+interface LicenseInfo {
+    /**
+     * Title of the License Info.
+     */
+    title: string;
+    /**
+     * License to be shown as plain text in `<pre>` element.
+     */
+    text?: string;
+    /**
+     * URL to license file to be shown in iFrame.
+     */
+    iframe?: string;
+    /**
+     * URL to license REST end point. License texts are lazy loaded separately for
+     * each component. Requires a service to provide license data.
+     */
+    api?: string;
+    /**
+     * In API View, custom license file icon.
+     */
+    icon?: string;
+}
+interface ApiInfo {
+    /**
+     * Name of License category.
+     */
+    name: string;
+    /**
+     * API href.
+     */
+    href: string;
+    /**
+     * State if dropdown is open.
+     */
+    isOpen?: boolean;
+    /**
+     * License files path.
+     */
+    files?: ApiInfo[];
+    /**
+     * Content of license file.
+     */
+    content?: string;
+}
+
+declare class SiAboutComponent implements OnInit {
+    private http;
+    private sanitizer;
+    /**
+     * Title shown above the about information.
+     */
+    readonly aboutTitle: _angular_core.InputSignal<string>;
+    /**
+     * Define mode to display the licenses. See {@link LicenseInfo}
+     */
+    readonly licenseInfo: _angular_core.InputSignal<LicenseInfo>;
+    /**
+     * Path to the application logo. Use for image
+     */
+    readonly icon: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Name of element icon. Use as alternative to image
+     */
+    readonly iconName: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Title of this application.
+     */
+    readonly appName: _angular_core.InputSignal<string>;
+    /**
+     * Sub titles of the application. Shown as a list below the application name. (Optional)
+     */
+    readonly subheading: _angular_core.InputSignal<string[] | undefined>;
+    /**
+     * Link to `Acceptable Use Policy`.
+     */
+    readonly acceptableUsePolicyLink: _angular_core.InputSignal<Link | undefined>;
+    /**
+     * Link to `Corporate Information`.
+     */
+    readonly imprintLink: _angular_core.InputSignal<Link | undefined>;
+    /**
+     * Link to `Privacy Notice`.
+     */
+    readonly privacyLink: _angular_core.InputSignal<Link | undefined>;
+    /**
+     * Link to `Cookie Notice`.
+     */
+    readonly cookieNoticeLink: _angular_core.InputSignal<Link | undefined>;
+    /**
+     * Link to `Terms of Use`.
+     */
+    readonly termsLink: _angular_core.InputSignal<Link | undefined>;
+    /**
+     * Additional links listed in the about section.
+     *
+     * @defaultValue []
+     */
+    readonly links: _angular_core.InputSignal<Link[]>;
+    /**
+     * Copyright information to be displayed. Alternatively, you can use the {@link SI_COPYRIGHT_DETAILS} global inject.
+     */
+    readonly copyrightDetails: _angular_core.InputSignal<CopyrightDetails | undefined>;
+    protected readonly sanitizedUrl: _angular_core.Signal<_angular_platform_browser.SafeResourceUrl | undefined>;
+    protected readonly licenseApi: _angular_core.WritableSignal<ApiInfo[]>;
+    protected readonly icons: Record<"elementDocument", string>;
+    ngOnInit(): void;
+    protected toggleLoadLicenseApi(apiInfo: ApiInfo): void;
+    protected toggleLoadLicenseContent(apiInfo: ApiInfo): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiAboutComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SiAboutComponent, "si-about", never, { "aboutTitle": { "alias": "aboutTitle"; "required": true; "isSignal": true; }; "licenseInfo": { "alias": "licenseInfo"; "required": true; "isSignal": true; }; "icon": { "alias": "icon"; "required": false; "isSignal": true; }; "iconName": { "alias": "iconName"; "required": false; "isSignal": true; }; "appName": { "alias": "appName"; "required": true; "isSignal": true; }; "subheading": { "alias": "subheading"; "required": false; "isSignal": true; }; "acceptableUsePolicyLink": { "alias": "acceptableUsePolicyLink"; "required": false; "isSignal": true; }; "imprintLink": { "alias": "imprintLink"; "required": false; "isSignal": true; }; "privacyLink": { "alias": "privacyLink"; "required": false; "isSignal": true; }; "cookieNoticeLink": { "alias": "cookieNoticeLink"; "required": false; "isSignal": true; }; "termsLink": { "alias": "termsLink"; "required": false; "isSignal": true; }; "links": { "alias": "links"; "required": false; "isSignal": true; }; "copyrightDetails": { "alias": "copyrightDetails"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class SiAboutModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiAboutModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<SiAboutModule, never, [typeof SiAboutComponent], [typeof SiAboutComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<SiAboutModule>;
+}
+
+export { SiAboutComponent, SiAboutModule };
+export type { ApiInfo, LicenseInfo };

package/accordion/index.d.ts

@@ -1,9 +1,152 @@
-/**
- * Copyright (c) Siemens 2016 - 2025
- * SPDX-License-Identifier: MIT
- */
-export * from './si-collapsible-panel.component';
-export * from './si-accordion.component';
-export * from './si-accordion.service';
-export * from './si-accordion-hcollapse.service';
-export * from './si-accordion.module';
+import * as _angular_core from '@angular/core';
+import { AfterContentInit, OnChanges } from '@angular/core';
+import { BackgroundColorVariant } from '@siemens/element-ng/common';
+import { Subject } from 'rxjs';
+
+declare class SiCollapsiblePanelComponent {
+    /**
+     * Heading for the collapsible panel.
+     */
+    readonly heading: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Additional CSS classes for the top element.
+     *
+     * @defaultValue ''
+     */
+    readonly headerCssClasses: _angular_core.InputSignal<string>;
+    /**
+     * Additional CSS classes for the collapsible content region.
+     *
+     * @defaultValue ''
+     */
+    readonly contentBgClasses: _angular_core.InputSignal<string>;
+    /**
+     * Additional CSS classes for the wrapping content element.
+     *
+     * @defaultValue ''
+     */
+    readonly contentCssClasses: _angular_core.InputSignal<string>;
+    /**
+     * Expand/collapse the panel.
+     *
+     * @defaultValue false
+     */
+    readonly opened: _angular_core.ModelSignal<boolean>;
+    /**
+     * The icon to be displayed besides the heading.
+     */
+    readonly icon: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Whether the si-collapsible-panel is disabled.
+     *
+     * @defaultValue false
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /** Color to use for component background */
+    readonly colorVariant: _angular_core.InputSignal<BackgroundColorVariant | undefined>;
+    /**
+     * Defines the content of the optional badge. Should be a number or something like "100+".
+     * if undefined or empty string, no badge is displayed
+     */
+    readonly badge: _angular_core.InputSignal<string | number | undefined>;
+    /**
+     * Defines the background color of the badge. Default is specific to Element flavour.
+     */
+    readonly badgeColor: _angular_core.InputSignal<string | undefined>;
+    /**
+     * An event emitted when the user triggered expand/collapse and emit with the new open state.
+     * The event is emitted before the animation happens.
+     */
+    readonly panelToggle: _angular_core.OutputEmitterRef<boolean>;
+    protected readonly hcollapsed: _angular_core.Signal<boolean>;
+    protected readonly fullHeight: _angular_core.Signal<boolean>;
+    protected controlId: string;
+    protected headerId: string;
+    protected isHCollapsible: boolean;
+    protected readonly icons: Record<"elementDown2", string>;
+    private readonly destroyRef;
+    private readonly accordionService;
+    private readonly accordionHCollapseService;
+    private enableAnimation;
+    private readonly animationsGloballyDisabled;
+    private lastScrollPos;
+    private readonly contentRef;
+    constructor();
+    protected get showHide(): string;
+    /**
+     * Expand/collapse panel.
+     * @param open - indicate the panel shall open or close
+     * @param enableAnimation - with animation
+     */
+    openClose(open: boolean, enableAnimation?: boolean): void;
+    protected doToggle(event?: Event): void;
+    protected keydown(event: KeyboardEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiCollapsiblePanelComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SiCollapsiblePanelComponent, "si-collapsible-panel", never, { "heading": { "alias": "heading"; "required": false; "isSignal": true; }; "headerCssClasses": { "alias": "headerCssClasses"; "required": false; "isSignal": true; }; "contentBgClasses": { "alias": "contentBgClasses"; "required": false; "isSignal": true; }; "contentCssClasses": { "alias": "contentCssClasses"; "required": false; "isSignal": true; }; "opened": { "alias": "opened"; "required": false; "isSignal": true; }; "icon": { "alias": "icon"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "colorVariant": { "alias": "colorVariant"; "required": false; "isSignal": true; }; "badge": { "alias": "badge"; "required": false; "isSignal": true; }; "badgeColor": { "alias": "badgeColor"; "required": false; "isSignal": true; }; }, { "opened": "openedChange"; "panelToggle": "panelToggle"; }, never, ["[si-panel-heading]", "*"], true, never>;
+}
+
+declare class SiAccordionComponent implements AfterContentInit, OnChanges {
+    /** @defaultValue true */
+    readonly expandFirstPanel: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /** @defaultValue false */
+    readonly fullHeight: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /** @defaultValue false */
+    readonly hcollapsed: _angular_core.InputSignal<boolean>;
+    /**
+     * Indicate whether the accordion is collapsed.
+     * @internal
+     */
+    readonly collapsed: _angular_core.Signal<boolean>;
+    private readonly panels;
+    private responsive;
+    private destroyer;
+    private service;
+    private resizeObserver;
+    private element;
+    private accordionHCollapseService;
+    ngOnChanges(): void;
+    ngAfterContentInit(): void;
+    private calcFullHeight;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiAccordionComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SiAccordionComponent, "si-accordion", never, { "expandFirstPanel": { "alias": "expandFirstPanel"; "required": false; "isSignal": true; }; "fullHeight": { "alias": "fullHeight"; "required": false; "isSignal": true; }; "hcollapsed": { "alias": "hcollapsed"; "required": false; "isSignal": true; }; }, {}, ["panels"], ["*"], true, never>;
+}
+
+/** @internal */
+declare class SiAccordionService {
+    /**
+     * Emit an item in the accordion which should be toggled.
+     */
+    readonly toggle$: Subject<any>;
+    /**
+     * Subject to emit when the items should be expanded to their full height or restored to normal height.
+     *
+     * @defaultValue null
+     */
+    readonly fullHeight: _angular_core.WritableSignal<boolean | null>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiAccordionService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<SiAccordionService>;
+}
+
+/** @internal */
+declare class SiAccordionHCollapseService {
+    /**
+     * Emitting the current horizontal collapsed state.
+     *
+     * @defaultValue undefined
+     */
+    readonly hcollapsed: _angular_core.WritableSignal<boolean | undefined>;
+    /**
+     * Subject to emit to open the accordion.
+     */
+    readonly open$: Subject<unknown>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiAccordionHCollapseService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<SiAccordionHCollapseService>;
+}
+
+declare class SiAccordionModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SiAccordionModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<SiAccordionModule, never, [typeof SiAccordionComponent, typeof SiCollapsiblePanelComponent], [typeof SiAccordionComponent, typeof SiCollapsiblePanelComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<SiAccordionModule>;
+}
+
+export { SiAccordionComponent, SiAccordionHCollapseService, SiAccordionModule, SiAccordionService, SiCollapsiblePanelComponent };

package/action-modal/index.d.ts

@@ -1,6 +1,96 @@
+import { ModalDependencyInjectionOptions } from '@siemens/element-ng/modal';
+import { Observable } from 'rxjs';
+import { TranslatableString } from '@siemens/element-translate-ng/translate';
+import * as i0 from '@angular/core';
+
 /**
  * Copyright (c) Siemens 2016 - 2025
  * SPDX-License-Identifier: MIT
  */
-export * from './si-action-dialog.service';
-export * from './si-action-dialog.types';
+
+type AlertDialogResult = 'confirm';
+type EditDiscardDialogResult = 'save' | 'discard' | 'cancel';
+type ConfirmationDialogResult = 'confirm' | 'decline';
+type DeleteConfirmationDialogResult = 'delete' | 'cancel';
+/**
+ * Base type for all action dialogs
+ * @typeParam TResult - Type of the dialog result.
+ */
+interface ActionDialogBase<TResult> {
+    /** The message. */
+    message?: TranslatableString;
+    /** The heading. */
+    heading?: TranslatableString;
+    /** Icon displayed in the heading. */
+    icon?: string;
+    /** Parameters for the translate pipe. */
+    translationParams?: Record<string, any>;
+    /**
+     * Callback for delaying dismiss with a progress indicator until the
+     * returned {@link Observable} emits.
+     */
+    delayDismiss?: (result: TResult) => Observable<TResult>;
+}
+/** An action dialog showing an alert */
+interface AlertDialog extends ActionDialogBase<AlertDialogResult> {
+    type: 'alert';
+    /** Label of the confirmation button. */
+    confirmBtnName?: TranslatableString;
+}
+/** An action dialog for a confirmation. */
+interface ConfirmationDialog extends ActionDialogBase<ConfirmationDialogResult> {
+    type: 'confirmation';
+    /** Label of the confirmation button. */
+    confirmBtnName?: TranslatableString;
+    /** Label of the decline button. */
+    declineBtnName?: TranslatableString;
+}
+/** An action dialog for an edit/discard prompt. */
+interface EditDiscardDialog extends ActionDialogBase<EditDiscardDialogResult> {
+    type: 'edit-discard';
+    /** Whether to disable the save button. */
+    disableSave?: boolean;
+    /** Label of the save button. */
+    saveBtnName?: TranslatableString;
+    /** Label of the discard button. */
+    discardBtnName?: TranslatableString;
+    /** Label of the cancel button. */
+    cancelBtnName?: TranslatableString;
+    /** Message when {@link disableSave} is set. */
+    disableSaveMessage?: TranslatableString;
+    /** Label of the discard button when {@link disableSave} is set. */
+    disableSaveDiscardBtnName?: TranslatableString;
+}
+/** An action dialog for a delete confirmation. */
+interface DeleteConfirmationDialog extends ActionDialogBase<DeleteConfirmationDialogResult> {
+    type: 'delete-confirm';
+    /** Label of the delete button. */
+    deleteBtnName?: TranslatableString;
+    /** Label of the cancel button. */
+    cancelBtnName?: TranslatableString;
+}
+/** All possible action dialogs. */
+type ActionDialog = AlertDialog | ConfirmationDialog | EditDiscardDialog | DeleteConfirmationDialog | never;
+/** Returns the return value type for the given action dialog type */
+type ActionDialogReturnType<T extends ActionDialogBase<any>> = T extends AlertDialog ? AlertDialogResult : T extends ConfirmationDialog ? ConfirmationDialogResult : T extends EditDiscardDialog ? EditDiscardDialogResult : T extends DeleteConfirmationDialog ? DeleteConfirmationDialogResult : never;
+
+/**
+ * The service provides convenient methods to show common modal dialogs.
+ * All return an observable, which emit the dialog results. After emitting,
+ * the observables complete. Therefore, clients do not need to unsubscribe.
+ */
+declare class SiActionDialogService {
+    private modalService;
+    /**
+     * Shows an action dialog
+     * @param dialog - The dialog configuration
+     * @param diOptions - Optional DI configuration.
+     * @returns Observable for the result of the dialog. Need to `subscribe()` to show the dialog
+     */
+    showActionDialog<T extends ActionDialog>(dialog: T, diOptions?: ModalDependencyInjectionOptions): Observable<ActionDialogReturnType<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiActionDialogService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiActionDialogService>;
+}
+
+export { SiActionDialogService };
+export type { ActionDialog, ActionDialogReturnType, AlertDialog, AlertDialogResult, ConfirmationDialog, ConfirmationDialogResult, DeleteConfirmationDialog, DeleteConfirmationDialogResult, EditDiscardDialog, EditDiscardDialogResult };