/**
 *
 * carbon-angular v0.0.0 | scroll-custom-event.interface.d.ts
 *
 * Copyright 2014, 2026 IBM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


/**
 * A custom structure that represents a custom event to emit when scroll.
 *
 * ```typescript
 * export interface ScrollCustomEvent {
 * 	atTop: boolean;
 * 	atBottom: boolean;
 * 	event: Event;
 * }
 * ```
 */
export interface ScrollCustomEvent {
    /**
     * Flag to communicate if scroll is at the top of container
     */
    atTop: boolean;
    /**
     * Flag to communicate if scroll is at the bottom of container
     */
    atBottom: boolean;
    /**
     * Complete Scroll event available to get any more data required
     */
    event: Event;
}