UNPKG

1.68 kBTypeScriptView Raw
1import { ElementRef } from '@angular/core';
2/**
3 * @name Scroll
4 * @description
5 * Scroll is a non-flexboxed scroll area that can scroll horizontally or vertically. `ion-Scroll` Can be used in places where you may not need a full page scroller, but a highly customized one, such as image scubber or comment scroller.
6 * @usage
7 * ```html
8 * <ion-scroll scrollX="true">
9 * </ion-scroll>
10 *
11 * <ion-scroll scrollY="true">
12 * </ion-scroll>
13 *
14 * <ion-scroll scrollX="true" scrollY="true">
15 * </ion-scroll>
16 * ```
17 * @demo /docs/demos/src/scroll/
18 */
19export declare class Scroll {
20 _scrollX: boolean;
21 _scrollY: boolean;
22 _zoom: boolean;
23 _maxZoom: number;
24 /**
25 * @input {boolean} If true, scrolling along the X axis is enabled.
26 */
27 scrollX: any;
28 /**
29 * @input {boolean} If true, scrolling along the Y axis is enabled; requires the following CSS declaration: ion-scroll { white-space: nowrap; }
30 */
31 scrollY: any;
32 /**
33 * @input {boolean} If true, zooming is enabled.
34 */
35 zoom: any;
36 /**
37 * @input {number} Set the max zoom amount.
38 */
39 maxZoom: any;
40 /**
41 * @hidden
42 */
43 maxScale: number;
44 /**
45 * @hidden
46 */
47 zoomDuration: number;
48 /** @internal */
49 _scrollContent: ElementRef;
50 constructor();
51 /**
52 * @hidden
53 * Add a scroll event handler to the scroll element if it exists.
54 * @param {Function} handler The scroll handler to add to the scroll element.
55 * @returns {?Function} a function to remove the specified handler, otherwise
56 * undefined if the scroll element doesn't exist.
57 */
58 addScrollEventListener(handler: any): () => void;
59}