igniteui-angular
Version:
Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps
33 lines (32 loc) • 1.02 kB
TypeScript
import { IgxOverlayService } from '../overlay';
/**
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll).
* Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService.
*/
export interface IScrollStrategy {
/**
* Initializes the strategy. Should be called once
*
* @param document reference to Document object.
* @param overlayService IgxOverlay service to use in this strategy.
* @param id Unique id for this strategy.
* ```typescript
* settings.scrollStrategy.initialize(document, overlay, id);
* ```
*/
initialize(document: Document, overlayService: IgxOverlayService, id: string): any;
/**
* Attaches the strategy
* ```typescript
* settings.scrollStrategy.attach();
* ```
*/
attach(): void;
/**
* Detaches the strategy
* ```typescript
* settings.scrollStrategy.detach();
* ```
*/
detach(): void;
}