primeng/types/primeng-types-image.d.ts

PrimeNG is an open source UI library for Angular featuring a rich set of 80+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeB

import { TemplateRef } from '@angular/core';
import { MotionOptions } from '@primeuix/motion';
import { PassThroughOption, PassThrough } from 'primeng/api';

/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link Image.pt}
 * @group Interface
 */
interface ImagePassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLSpanElement, I>;
    /**
     * Used to pass attributes to the image's DOM element.
     */
    image?: PassThroughOption<HTMLImageElement, I>;
    /**
     * Used to pass attributes to the preview mask button's DOM element.
     */
    previewMask?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the preview icon's DOM element.
     */
    previewIcon?: PassThroughOption<SVGElement, I>;
    /**
     * Used to pass attributes to the mask's DOM element.
     */
    mask?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the toolbar's DOM element.
     */
    toolbar?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the rotate right button's DOM element.
     */
    rotateRightButton?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the rotate left button's DOM element.
     */
    rotateLeftButton?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the zoom out button's DOM element.
     */
    zoomOutButton?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the zoom in button's DOM element.
     */
    zoomInButton?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the close button's DOM element.
     */
    closeButton?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the original/preview image's DOM element.
     */
    original?: PassThroughOption<HTMLImageElement, I>;
    /**
     * Used to pass options to the motion component/directive.
     */
    motion?: MotionOptions;
}
/**
 * Defines valid pass-through options in Image.
 * @see {@link ImagePassThroughOptions}
 *
 * @template I Type of instance.
 */
type ImagePassThrough<I = unknown> = PassThrough<I, ImagePassThroughOptions<I>>;
/**
 * Custom image template context.
 * @group Interface
 */
interface ImageImageTemplateContext {
    /**
     * Callback to invoke on image error.
     */
    errorCallback: (event: Event) => void;
}
/**
 * Custom preview template context.
 * @group Interface
 */
interface ImagePreviewTemplateContext {
    /**
     * Style class of the preview image element.
     */
    class: string;
    /**
     * Inline style of the preview image element.
     */
    style: {
        [key: string]: any;
    };
    /**
     * Callback to invoke on preview image click.
     */
    previewCallback: () => void;
}
/**
 * Defines valid templates in Image.
 * @group Templates
 */
interface ImageTemplates {
    /**
     * Custom indicator template.
     */
    indicator(): TemplateRef<void>;
    /**
     * Custom image template.
     * @param {Object} context - image context.
     */
    image(context: ImageImageTemplateContext): TemplateRef<ImageImageTemplateContext>;
    /**
     * Custom preview template.
     * @param {Object} context - preview context.
     */
    preview(context: ImagePreviewTemplateContext): TemplateRef<ImagePreviewTemplateContext>;
    /**
     * Custom rotate right icon template.
     */
    rotaterighticon(): TemplateRef<void>;
    /**
     * Custom rotate left icon template.
     */
    rotatelefticon(): TemplateRef<void>;
    /**
     * Custom zoom out icon template.
     */
    zoomouticon(): TemplateRef<void>;
    /**
     * Custom zoom in icon template.
     */
    zoominicon(): TemplateRef<void>;
    /**
     * Custom close icon template.
     */
    closeicon(): TemplateRef<void>;
}

export type { ImageImageTemplateContext, ImagePassThrough, ImagePassThroughOptions, ImagePreviewTemplateContext, ImageTemplates };