UNPKG

1.56 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 actual size icon.
21 */
22 actualSize: boolean;
23 /**
24 * Once the slide transition is completed, how much time should take zoom plugin to activate
25 * @description Some css styles will be added to the images if zoom is enabled.
26 * So it might conflict if you add any custom styles to the images such as the initial transition while opening the gallery.
27 * So you can delay adding zoom related styles to the images by changing the value of enableZoomAfter.
28 */
29 enableZoomAfter: number;
30 /**
31 * Show zoom in, zoom out icons
32 */
33 showZoomInOutIcons: boolean;
34 /**
35 * Actual size icons classnames.
36 * Specify classnames for both ZoomIn and ZoomOut states
37 * You can use `actualSizeIcons: { zoomIn: 'lg-actual-size', zoomOut: 'lg-zoom-out' }`
38 * to show actual size icons instead of zoom in and zoom out icons.
39 */
40 actualSizeIcons: ActualSizeIcons;
41 /**
42 * Custom translation strings for aria-labels
43 */
44 zoomPluginStrings: ZoomStrings;
45}
46export declare const zoomSettings: ZoomSettings;