@zendeskgarden/container-schedule/dist/typings/useSchedule.d.ts

Containers relating to schedule in the Garden Design System

/**
 * Copyright Zendesk, Inc.
 *
 * Use of this source code is governed under the Apache License, Version 2.0
 * found at http://www.apache.org/licenses/LICENSE-2.0.
 */
export interface IUseScheduleProps {
    /** The duration of a schedule in miliseconds */
    duration?: number;
    /** The delay in miliseconds prior to the beginning of the schedule */
    delayMS?: number;
    /** Determines whether a schedule should loop */
    loop?: boolean;
}
export interface IUseScheduleReturnValue {
    elapsed: number;
    delayMS: number;
    delayComplete: boolean;
}
export declare const useSchedule: ({ duration, delayMS, loop }?: IUseScheduleProps) => IUseScheduleReturnValue;