@siemens/element-ng 47.5.0 → 47.6.0

package/threshold/si-threshold.module.d.ts

@@ -0,0 +1,7 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./si-threshold.component";
+export declare class SiThresholdModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiThresholdModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SiThresholdModule, never, [typeof i1.SiThresholdComponent], [typeof i1.SiThresholdComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SiThresholdModule>;
+}

package/tour/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+export * from './si-tour.service';
+export * from './si-tour.model';

package/tour/package.json

@@ -0,0 +1,3 @@
+{
+  "module": "../fesm2022/siemens-element-ng-tour.mjs"
+}

package/tour/si-tour-highlight.component.d.ts

@@ -0,0 +1,15 @@
+import * as i0 from "@angular/core";
+export declare class SiTourHighlightComponent {
+    private tourToken;
+    private anchor?;
+    protected readonly dim: import("@angular/core").WritableSignal<{
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+    }>;
+    constructor();
+    private updateHighlight;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTourHighlightComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SiTourHighlightComponent, "si-tour-highlight", never, {}, {}, never, never, true, never>;
+}

package/tour/si-tour-token.model.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import { ConnectedOverlayPositionChange } from '@angular/cdk/overlay';
+import { ElementRef, InjectionToken, WritableSignal } from '@angular/core';
+import { Subject } from 'rxjs';
+import { TourStep } from './si-tour.model';
+export interface TourStepInternal {
+    step: TourStep;
+    stepNumber: number;
+    totalSteps: number;
+    anchor?: ElementRef<HTMLElement>;
+}
+export type TourAction = 'next' | 'back' | 'cancel' | 'complete';
+export interface PositionChange {
+    change: ConnectedOverlayPositionChange;
+    anchor: ElementRef;
+}
+export interface TourToken {
+    currentStep: Subject<TourStepInternal>;
+    blocked: WritableSignal<boolean>;
+    positionChange: Subject<PositionChange | undefined>;
+    sizeChange: Subject<void>;
+    control: Subject<TourAction>;
+}
+export declare const SI_TOUR_TOKEN: InjectionToken<TourToken>;

package/tour/si-tour.component.d.ts

@@ -0,0 +1,31 @@
+import { OnDestroy } from '@angular/core';
+import { OverlayArrowPosition } from '@siemens/element-ng/common';
+import { TourAction, TourStepInternal } from './si-tour-token.model';
+import * as i0 from "@angular/core";
+export declare class SiTourComponent implements OnDestroy {
+    protected readonly positionClass: import("@angular/core").WritableSignal<string>;
+    protected readonly arrowPos: import("@angular/core").WritableSignal<OverlayArrowPosition | undefined>;
+    protected readonly step: import("@angular/core").WritableSignal<TourStepInternal | undefined>;
+    protected readonly show: import("@angular/core").WritableSignal<boolean>;
+    protected readonly icons: Record<"elementCancel", string>;
+    protected tourToken: import("./si-tour-token.model").TourToken;
+    protected backText: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected nextText: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected skipText: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected doneText: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected ariaLabelClose: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected progressText: import("@siemens/element-translate-ng/translate").TranslatableString;
+    private elementRef;
+    private subscription?;
+    private prevFocus;
+    private readonly focusTrap;
+    private document;
+    constructor();
+    ngOnDestroy(): void;
+    protected action(action: TourAction): void;
+    protected ensureFocused(): void;
+    protected keyListener(event: KeyboardEvent): void;
+    private updatePosition;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTourComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SiTourComponent, "si-tour", never, {}, {}, never, never, true, never>;
+}

package/tour/si-tour.model.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import { TranslatableString } from '@siemens/element-translate-ng/translate';
+/** Common options for tour step and as default for tour step */
+export interface TourStepCommonOptions {
+    /** Whether Scroll the element into view. */
+    scrollTo?: boolean | ScrollIntoViewOptions;
+    /** Custom handler to perform scrolling. */
+    scrollToHandler?: (element: HTMLElement) => void;
+    /**
+     * A function that returns a promise.
+     * When the promise resolves, the step will be shown. E.g. use this to open
+     * dialogs, etc.
+     */
+    beforeShowPromise?: () => Promise<any>;
+    /**
+     * A function that returns a promise.
+     * When the promise resolves, the next step will be shown. This can be used
+     * to 'clean up' action from `beforeShowPromise`.
+     */
+    beforeNextPromise?: () => Promise<any>;
+}
+/** Options for each tour step. */
+export interface TourStep extends TourStepCommonOptions {
+    /** Unique id for the step. Exposed in DOM as `data-step-id` */
+    id?: string;
+    /** Title to be displayed on the modal. */
+    title: TranslatableString;
+    /** Body text of the modal. */
+    text?: TranslatableString;
+    /** The element, the step should be attached to on the page. */
+    attachTo?: {
+        element: string | HTMLElement | (() => string | HTMLElement);
+        /**
+         * @deprecated this has no effect, position is automatic
+         */
+        on?: ModalPosition;
+    };
+}
+/** Options for tour */
+export interface TourOptions {
+    /** Default options applied to all tour steps. */
+    defaultStepOptions?: TourStepCommonOptions;
+}
+/**
+ * The position of the modal dialog with respect to the highlighted element.
+ * @deprecated this has no effect, position is automatic
+ */
+export type ModalPosition = 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end';

package/tour/si-tour.service.d.ts

@@ -0,0 +1,62 @@
+import { Subject } from 'rxjs';
+import { TourOptions, TourStep } from './si-tour.model';
+import * as i0 from "@angular/core";
+export declare class SiTourService {
+    private injector;
+    private resizeObserver;
+    private overlay;
+    private outsideClickDispatcher;
+    private overlayRefHighlight?;
+    private overlayRef?;
+    private portal?;
+    private options;
+    private steps;
+    private currentStepIndex;
+    private currentStep?;
+    private active;
+    private tourToken;
+    private positionChangeSub?;
+    private resizeSub?;
+    private document;
+    constructor();
+    /**
+     * Event triggered after the tour is completed.
+     */
+    readonly onTourComplete: Subject<void>;
+    /**
+     * Event triggered after the tour is cancelled, either through skip button or closing the tour dialog.
+     */
+    readonly onTourCancel: Subject<void>;
+    /**
+     * Sets options for the whole tour.
+     */
+    setOptions(options: TourOptions): void;
+    /**
+     * Add steps to the tour
+     */
+    addSteps(steps: TourStep[]): void;
+    /**
+     * Clear all steps
+     */
+    clearSteps(): void;
+    /**
+     * Start the tour
+     */
+    start(): void;
+    /**
+     * Finish the tour
+     */
+    complete(): void;
+    private controlAction;
+    private makeStep;
+    private scrollIntoView;
+    private handleBeforeNextPromise;
+    private makeOverlay;
+    private handleResizeSubscription;
+    private isElementVisible;
+    private handlePositionChangeSubscription;
+    private getElement;
+    private hide;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTourService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiTourService>;
+}

package/translate/si-translatable-keys.interface.d.ts

@@ -124,8 +124,14 @@ export interface SiTranslatableKeys {
     'SI_LAUNCHPAD.TITLE'?: string;
     'SI_LIST_DETAILS.BACK'?: string;
     'SI_LOADING_SPINNER.LABEL'?: string;
+    'SI_MAIN_DETAIL_CONTAINER.BACK'?: string;
     'SI_NAVBAR.OPEN_LAUNCHPAD'?: string;
     'SI_NAVBAR.TOGGLE_NAVIGATION'?: string;
+    'SI_NAVBAR_VERTICAL.COLLAPSE'?: string;
+    'SI_NAVBAR_VERTICAL.EXPAND'?: string;
+    'SI_NAVBAR_VERTICAL.SEARCH_PLACEHOLDER'?: string;
+    'SI_NAVBAR_VERTICAL.SKIP_LINK.MAIN_LABEL'?: string;
+    'SI_NAVBAR_VERTICAL.SKIP_LINK.NAVIGATION_LABEL'?: string;
     'SI_PAGINATION.BACK'?: string;
     'SI_PAGINATION.FORWARD'?: string;
     'SI_PAGINATION.NAV_LABEL'?: string;
@@ -160,7 +166,17 @@ export interface SiTranslatableKeys {
     'SI_STATUS_BAR.COLLAPSE'?: string;
     'SI_STATUS_BAR.EXPAND'?: string;
     'SI_STATUS_BAR.MUTE'?: string;
+    'SI_THRESHOLD.ADD'?: string;
+    'SI_THRESHOLD.DELETE'?: string;
+    'SI_THRESHOLD.INPUT_LABEL'?: string;
+    'SI_THRESHOLD.STATUS'?: string;
     'SI_TOAST.CLOSE'?: string;
+    'SI_TOUR.BACK'?: string;
+    'SI_TOUR.CLOSE'?: string;
+    'SI_TOUR.DONE'?: string;
+    'SI_TOUR.NEXT'?: string;
+    'SI_TOUR.PROGRESS'?: string;
+    'SI_TOUR.SKIP'?: string;
     'SI_TREE_VIEW.COLLAPSE_ALL'?: string;
     'SI_TREE_VIEW.EXPAND_ALL'?: string;
     'SI_TYPEAHEAD.AUTOCOMPLETE_LIST_LABEL'?: string;

package/tree-view/si-tree-view.component.d.ts

@@ -159,7 +159,7 @@ export declare class SiTreeViewComponent implements OnInit, OnChanges, OnDestroy
      */
     readonly enableIcon: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
     /**
-     * Shows or hides context menu button.
+     * Shows or hides context menu button and also controls context menu visibility on right click.
      * @defaultValue true
      * @defaultref {@link SiTreeViewService#enableContextMenuButton}
      */