119 lines
2.4 KiB
TypeScript
119 lines
2.4 KiB
TypeScript
/**
|
|
*
|
|
* Displays an image with preview and tranformation options. For multiple image, see Galleria.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/image/)
|
|
*
|
|
* @module image
|
|
*
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
|
|
|
/**
|
|
* Defines valid properties in Image component.
|
|
*/
|
|
export interface ImageProps {
|
|
/**
|
|
* Controls the preview functionality.
|
|
* @defaultValue false
|
|
*/
|
|
preview?: boolean | undefined;
|
|
/**
|
|
* Inline style of the image element.
|
|
*/
|
|
imageStyle?: any;
|
|
/**
|
|
* Style class of the image element.
|
|
*/
|
|
imageClass?: any;
|
|
/**
|
|
* Custom indicator icon.
|
|
* @defaultValue pi pi-eye
|
|
*/
|
|
indicatorIcon?: string;
|
|
/**
|
|
* Disable the zoom-in button
|
|
* @defaultValue false
|
|
*/
|
|
zoomInDisabled?: boolean | undefined;
|
|
/**
|
|
* Disable the zoom-out button
|
|
* @defaultValue false
|
|
*/
|
|
zoomOutDisabled?: boolean | undefined;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in Image slots.
|
|
*/
|
|
export interface ImageSlots {
|
|
/**
|
|
* Custom indicator template.
|
|
*/
|
|
indicator(): VNode[];
|
|
/**
|
|
* Custom refresh template.
|
|
*/
|
|
refresh(): VNode[];
|
|
/**
|
|
* Custom undo template.
|
|
*/
|
|
undo(): VNode[];
|
|
/**
|
|
* Custom zoomout template.
|
|
*/
|
|
zoomout(): VNode[];
|
|
/**
|
|
* Custom zoomin template.
|
|
*/
|
|
zoomin(): VNode[];
|
|
/**
|
|
* Custom close template.
|
|
*/
|
|
close(): VNode[];
|
|
}
|
|
|
|
export interface ImageEmits {}
|
|
|
|
/**
|
|
* **PrimeVue - Image**
|
|
*
|
|
* _Displays an image with preview and tranformation options. For multiple image, see Galleria._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/image/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare class Image extends ClassComponent<ImageProps, ImageSlots, ImageEmits> {
|
|
/**
|
|
* Triggered when the preview overlay is shown.
|
|
*
|
|
* @memberof Image
|
|
*/
|
|
show(): void;
|
|
/**
|
|
* Triggered when the preview overlay is hidden.
|
|
*
|
|
* @memberof Image
|
|
*/
|
|
hide(): void;
|
|
/**
|
|
* Triggered when an error occurs while loading an image file.
|
|
*
|
|
* @memberof Image
|
|
*/
|
|
error(): void;
|
|
}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
Image: GlobalComponentConstructor<Image>;
|
|
}
|
|
}
|
|
|
|
export default Image;
|