@acorex/components 22.0.0-next.5 → 22.0.0-next.8

package/types/acorex-components-file-viewer.d.ts

@@ -1,8 +1,11 @@
+import { AXComponentContent, AXComponentInputs } from '@acorex/core/components';
 import * as _angular_core from '@angular/core';
-import { Provider, OnDestroy } from '@angular/core';
+import { OnDestroy, TemplateRef, Type, Provider } from '@angular/core';
+import { Subject } from 'rxjs';
+import * as dist_packages_core_types_acorex_core_components from 'dist/packages/core/types/acorex-core-components';
+import { AXStyleColorType, AXComponentClosedPromise } from '@acorex/cdk/common';
 import * as _acorex_core_file from '@acorex/core/file';
 import { AXFileTypeExtensionHint, AXFileType, AXFileTypeViewComponent } from '@acorex/core/file';
-import { AXStyleColorType } from '@acorex/cdk/common';
 import { SafeResourceUrl } from '@angular/platform-browser';
 
 /** Single item displayed in a file-viewer carousel. */
@@ -24,6 +27,18 @@ interface AXFileViewerViewPayload {
     index: number;
     active: boolean;
 }
+/** Component or template rendered in the file-viewer header center slot. */
+type AXFileViewerHeaderContent = AXComponentContent;
+/** Inputs passed to {@link AXFileViewerHeaderContent} when it is a component. */
+type AXFileViewerHeaderContentInputs = AXComponentInputs;
+/** Placeholder component or template shown in the center when {@link AXFileViewerHeaderContent} is omitted. */
+type AXFileViewerHeaderPlaceholderContent = AXComponentContent;
+/** Inputs passed to the header placeholder when it is a component. */
+type AXFileViewerHeaderPlaceholderInputs = AXComponentInputs;
+/** Component or template rendered instead of the built-in fallback viewer for `file` type items. */
+type AXFileViewerFallbackContent = AXComponentContent;
+/** Inputs passed to {@link AXFileViewerFallbackContent} when it is a component. */
+type AXFileViewerFallbackContentInputs = AXComponentInputs;
 
 /** Carousel state shared between container, slides and thumbnails. Provided per-container. */
 declare class AXFileViewerService {
@@ -36,34 +51,47 @@ declare class AXFileViewerService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXFileViewerService>;
 }
 
-/** Registers file-viewer components on standard file-type catalog entries. */
-declare function provideFileViewer(): Provider[];
-
 /** Infers a file-type catalog name from the item. */
 declare function resolveFileViewerFileType(item: AXFileViewerItem): string;
 /** Builds an extension hint from item metadata. */
 declare function buildFileViewerExtensionHint(item: AXFileViewerItem): AXFileTypeExtensionHint | undefined;
 
-declare function createFileViewerFileTypes(): AXFileType[];
-
 declare class AXFileViewerContainerComponent implements OnDestroy {
     #private;
     readonly items: _angular_core.InputSignal<AXFileViewerItem[]>;
+    readonly startIndex: _angular_core.InputSignal<number>;
     readonly thumbnail: _angular_core.InputSignal<boolean>;
     readonly pagination: _angular_core.InputSignal<boolean>;
     readonly download: _angular_core.InputSignal<boolean>;
     readonly fullscreen: _angular_core.InputSignal<boolean>;
+    /** When true, opens in a gallery overlay and closes when fullscreen exits. */
+    readonly galleryMode: _angular_core.InputSignal<boolean>;
+    /** Component or template rendered in the header center slot. */
+    readonly headerContent: _angular_core.InputSignal<AXFileViewerHeaderContent>;
+    /** Inputs for {@link headerContent} when it is a component. */
+    readonly headerContentInputs: _angular_core.InputSignal<dist_packages_core_types_acorex_core_components.AXComponentInputs>;
+    /** Context data exposed as `$implicit` to header templates. */
+    readonly headerContentData: _angular_core.InputSignal<unknown>;
+    /** Custom placeholder when {@link headerContent} is omitted. */
+    readonly headerContentPlaceholder: _angular_core.InputSignal<AXFileViewerHeaderPlaceholderContent>;
+    /** Inputs for {@link headerContentPlaceholder} when it is a component. */
+    readonly headerContentPlaceholderInputs: _angular_core.InputSignal<dist_packages_core_types_acorex_core_components.AXComponentInputs>;
+    /** Component or template replacing the built-in fallback viewer for `file` type items. */
+    readonly fallbackContent: _angular_core.InputSignal<AXFileViewerFallbackContent>;
+    /** Inputs for {@link fallbackContent} when it is a component. */
+    readonly fallbackContentInputs: _angular_core.InputSignal<dist_packages_core_types_acorex_core_components.AXComponentInputs>;
+    /** Context data exposed as `$implicit` to fallback templates. */
+    readonly fallbackContentData: _angular_core.InputSignal<unknown>;
     /** External loading flag — show overlay while parent data is being fetched. */
     readonly loading: _angular_core.InputSignal<boolean>;
+    readonly fullscreenClosed: _angular_core.OutputEmitterRef<void>;
     readonly service: AXFileViewerService;
     private readonly host;
-    private readonly zIndexService;
     private readonly fullScreenService;
     private readonly mainCarouselRef;
     private readonly thumbCarouselRef;
-    readonly fullscreenActive: _angular_core.WritableSignal<boolean>;
-    private zToken;
     private initToken;
+    readonly isFullscreenActive: _angular_core.WritableSignal<boolean>;
     /** True while carousels are being (re)initialized. */
     readonly initializing: _angular_core.WritableSignal<boolean>;
     readonly isBusy: _angular_core.Signal<boolean>;
@@ -74,34 +102,135 @@ declare class AXFileViewerContainerComponent implements OnDestroy {
     readonly currentTypeLabel: _angular_core.Signal<string>;
     readonly currentTypeColor: _angular_core.Signal<AXStyleColorType>;
     readonly slideCounter: _angular_core.Signal<string>;
+    readonly headerTemplateContent: _angular_core.Signal<TemplateRef<any>>;
+    readonly headerComponentContent: _angular_core.Signal<Type<unknown>>;
+    readonly headerPlaceholderTemplateContent: _angular_core.Signal<TemplateRef<any>>;
+    readonly headerPlaceholderComponentContent: _angular_core.Signal<Type<unknown>>;
+    readonly hasHeaderCenterContent: _angular_core.Signal<boolean>;
+    readonly headerContentContext: _angular_core.Signal<{
+        $implicit: unknown;
+        item: AXFileViewerItem;
+        items: AXFileViewerItem[];
+        selectedIndex: number;
+        slideCounter: string;
+    }>;
     readonly resolveFileType: typeof resolveFileViewerFileType;
     resolveTypeLabel(item: AXFileViewerItem): string;
     formatSize(size?: number): string;
     private readonly mainCarouselOptions;
     private readonly thumbnailCarouselOptions;
-    private acquireFullscreenZIndex;
-    private releaseFullscreenZIndex;
+    toggleFullscreen(): void;
+    enterFullscreen(): void;
+    /** @param emitGalleryClose When false, skips gallery close notification (used during service teardown). */
+    exitFullscreen(emitGalleryClose?: boolean): void;
+    closeGallery(): void;
     private initCarousels;
     private readonly onSlideChange;
     next(): void;
     prev(): void;
     goToIndex(index: number, speed?: number): void;
-    toggleFullscreen(): void;
     downloadCurrent(): Promise<void>;
     ngOnDestroy(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXFileViewerContainerComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXFileViewerContainerComponent, "ax-file-viewer-container", never, { "items": { "alias": "items"; "required": false; "isSignal": true; }; "thumbnail": { "alias": "thumbnail"; "required": false; "isSignal": true; }; "pagination": { "alias": "pagination"; "required": false; "isSignal": true; }; "download": { "alias": "download"; "required": false; "isSignal": true; }; "fullscreen": { "alias": "fullscreen"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; }, {}, never, ["ax-header"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXFileViewerContainerComponent, "ax-file-viewer-container", never, { "items": { "alias": "items"; "required": false; "isSignal": true; }; "startIndex": { "alias": "startIndex"; "required": false; "isSignal": true; }; "thumbnail": { "alias": "thumbnail"; "required": false; "isSignal": true; }; "pagination": { "alias": "pagination"; "required": false; "isSignal": true; }; "download": { "alias": "download"; "required": false; "isSignal": true; }; "fullscreen": { "alias": "fullscreen"; "required": false; "isSignal": true; }; "galleryMode": { "alias": "galleryMode"; "required": false; "isSignal": true; }; "headerContent": { "alias": "headerContent"; "required": false; "isSignal": true; }; "headerContentInputs": { "alias": "headerContentInputs"; "required": false; "isSignal": true; }; "headerContentData": { "alias": "headerContentData"; "required": false; "isSignal": true; }; "headerContentPlaceholder": { "alias": "headerContentPlaceholder"; "required": false; "isSignal": true; }; "headerContentPlaceholderInputs": { "alias": "headerContentPlaceholderInputs"; "required": false; "isSignal": true; }; "fallbackContent": { "alias": "fallbackContent"; "required": false; "isSignal": true; }; "fallbackContentInputs": { "alias": "fallbackContentInputs"; "required": false; "isSignal": true; }; "fallbackContentData": { "alias": "fallbackContentData"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; }, { "fullscreenClosed": "fullscreenClosed"; }, never, never, true, never>;
+}
+
+interface AXFileViewerGalleryConfig {
+    items: AXFileViewerItem[];
+    startIndex?: number;
+    thumbnail?: boolean;
+    download?: boolean;
+    loading?: boolean;
+    panelClass?: string[];
+    headerContent?: AXFileViewerHeaderContent | null;
+    headerContentInputs?: AXFileViewerHeaderContentInputs;
+    headerContentData?: unknown;
+    headerContentPlaceholder?: AXFileViewerHeaderPlaceholderContent | null;
+    headerContentPlaceholderInputs?: AXFileViewerHeaderPlaceholderInputs;
+    fallbackContent?: AXFileViewerFallbackContent | null;
+    fallbackContentInputs?: AXFileViewerFallbackContentInputs;
+    fallbackContentData?: unknown;
+}
+interface AXFileViewerGalleryRef<TResult = any> {
+    close: (data?: TResult) => void;
+    setInputs: (values: AXComponentInputs) => void;
+    bringToFront: () => void;
+    onClose: Subject<TResult>;
+    componentInstance?: AXFileViewerContainerComponent;
+}
+
+/** Opens {@link AXFileViewerContainerComponent} in fullscreen gallery mode. */
+declare class AXFileViewerGalleryService {
+    private readonly galleryList;
+    private readonly overlayService;
+    /**
+     * Opens a file viewer gallery in fullscreen.
+     * @param config - Gallery configuration
+     * @returns Promise that resolves when the gallery is closed
+     */
+    open(config: AXFileViewerGalleryConfig): AXComponentClosedPromise;
+    /**
+     * Closes a gallery by its ID.
+     * @param id - The gallery ID to close
+     * @param data - Optional data to pass to the close event
+     */
+    close<TResult = unknown>(id: number, data?: TResult): void;
+    /**
+     * Sets input values for a gallery by its ID.
+     * @param id - The gallery ID
+     * @param values - Object containing input values to set
+     */
+    setInputs(id: number, values: AXComponentInputs): void;
+    /**
+     * Brings a gallery to the front of all other overlays.
+     * @param id - The gallery ID to bring to front
+     */
+    bringToFront(id: number): void;
+    private openInternal;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXFileViewerGalleryService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXFileViewerGalleryService>;
+}
+
+/** Registers file-viewer components on standard file-type catalog entries. */
+declare function provideFileViewer(): Provider[];
+
+declare function createFileViewerFileTypes(): AXFileType[];
+
+/** Optional center header slot component for use with {@link headerContentPlaceholder}. */
+declare class AXFileViewerHeaderPlaceholderComponent {
+    readonly slideCounter: _angular_core.InputSignal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXFileViewerHeaderPlaceholderComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXFileViewerHeaderPlaceholderComponent, "ax-file-viewer-header-placeholder", never, { "slideCounter": { "alias": "slideCounter"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class AXFileViewerSlideComponent {
     readonly item: _angular_core.InputSignal<AXFileViewerItem>;
     readonly index: _angular_core.InputSignal<number>;
+    /** Component or template replacing the built-in fallback viewer for `file` type items. */
+    readonly fallbackContent: _angular_core.InputSignal<AXFileViewerFallbackContent>;
+    /** Inputs for {@link fallbackContent} when it is a component. */
+    readonly fallbackContentInputs: _angular_core.InputSignal<dist_packages_core_types_acorex_core_components.AXComponentInputs>;
+    /** Context data exposed as `$implicit` to fallback templates. */
+    readonly fallbackContentData: _angular_core.InputSignal<unknown>;
     private readonly service;
     readonly fileTypeName: _angular_core.Signal<string>;
     readonly extensionHint: _angular_core.Signal<_acorex_core_file.AXFileTypeExtensionHint>;
     readonly viewPayload: _angular_core.Signal<AXFileViewerViewPayload>;
+    readonly fallbackTemplateContent: _angular_core.Signal<TemplateRef<any>>;
+    readonly fallbackComponentContent: _angular_core.Signal<Type<unknown>>;
+    readonly useCustomFallback: _angular_core.Signal<boolean>;
+    readonly fallbackContentContext: _angular_core.Signal<{
+        $implicit: unknown;
+        payload: AXFileViewerViewPayload;
+        item: AXFileViewerItem;
+        index: number;
+        active: boolean;
+    }>;
+    readonly fallbackComponentInputs: _angular_core.Signal<{
+        payload: AXFileViewerViewPayload;
+    }>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXFileViewerSlideComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXFileViewerSlideComponent, "ax-file-viewer-slide", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXFileViewerSlideComponent, "ax-file-viewer-slide", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": true; "isSignal": true; }; "fallbackContent": { "alias": "fallbackContent"; "required": false; "isSignal": true; }; "fallbackContentInputs": { "alias": "fallbackContentInputs"; "required": false; "isSignal": true; }; "fallbackContentData": { "alias": "fallbackContentData"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class AXFileViewerThumbPreviewComponent {
@@ -176,5 +305,5 @@ declare class AXFileViewerFileFallbackComponent implements AXFileTypeViewCompone
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXFileViewerFileFallbackComponent, "ax-file-viewer-fallback", never, { "payload": { "alias": "payload"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { AXFileViewerAudioComponent, AXFileViewerContainerComponent, AXFileViewerFileFallbackComponent, AXFileViewerImageComponent, AXFileViewerPdfComponent, AXFileViewerService, AXFileViewerSlideComponent, AXFileViewerThumbPreviewComponent, AXFileViewerThumbnailsComponent, AXFileViewerVideoComponent, buildFileViewerExtensionHint, createFileViewerFileTypes, provideFileViewer, resolveFileViewerFileType };
-export type { AXFileViewerItem, AXFileViewerViewPayload };
+export { AXFileViewerAudioComponent, AXFileViewerContainerComponent, AXFileViewerFileFallbackComponent, AXFileViewerGalleryService, AXFileViewerHeaderPlaceholderComponent, AXFileViewerImageComponent, AXFileViewerPdfComponent, AXFileViewerService, AXFileViewerSlideComponent, AXFileViewerThumbPreviewComponent, AXFileViewerThumbnailsComponent, AXFileViewerVideoComponent, buildFileViewerExtensionHint, createFileViewerFileTypes, provideFileViewer, resolveFileViewerFileType };
+export type { AXFileViewerFallbackContent, AXFileViewerFallbackContentInputs, AXFileViewerGalleryConfig, AXFileViewerGalleryRef, AXFileViewerHeaderContent, AXFileViewerHeaderContentInputs, AXFileViewerHeaderPlaceholderContent, AXFileViewerHeaderPlaceholderInputs, AXFileViewerItem, AXFileViewerViewPayload };