UNPKG

1.74 kBTypeScriptView Raw
1export interface ActualSizeIcons {
2 zoomIn: 'lg-zoom-in' | 'lg-actual-size';
3 zoomOut: 'lg-zoom-out' | 'lg-actual-size';
4}
5export interface ZoomStrings {
6 zoomIn: string;
7 zoomOut: string;
8 viewActualSize: string;
9}
10export interface ZoomSettings {
11 /**
12 * Value of zoom should be incremented/decremented
13 */
14 scale: number;
15 /**
16 * Enable/Disable zoom option
17 */
18 zoom: boolean;
19 /**
20 * Enable/Disable infinite zoom
21 * @description If you set this to true, you can zoom in more than the original size of the image.
22 */
23 infiniteZoom: boolean;
24 /**
25 * Enable actual size icon.
26 */
27 actualSize: boolean;
28 /**
29 * Once the slide transition is completed, how much time should take zoom plugin to activate
30 * @description Some css styles will be added to the images if zoom is enabled.
31 * So it might conflict if you add any custom styles to the images such as the initial transition while opening the gallery.
32 * So you can delay adding zoom related styles to the images by changing the value of enableZoomAfter.
33 */
34 enableZoomAfter: number;
35 /**
36 * Show zoom in, zoom out icons
37 */
38 showZoomInOutIcons: boolean;
39 /**
40 * Actual size icons classnames.
41 * Specify classnames for both ZoomIn and ZoomOut states
42 * You can use `actualSizeIcons: { zoomIn: 'lg-actual-size', zoomOut: 'lg-zoom-out' }`
43 * to show actual size icons instead of zoom in and zoom out icons.
44 */
45 actualSizeIcons: ActualSizeIcons;
46 /**
47 * Custom translation strings for aria-labels
48 */
49 zoomPluginStrings: ZoomStrings;
50}
51export declare const zoomSettings: ZoomSettings;