two-dimension-scroll/dist/types.d.ts

A smooth scroll library that detects both horizontal and vertical scroll and converts them to vertical smooth scrolling

/**
 * 환경별 스크롤 옵션
 */
export interface EnvironmentScrollOptions {
    /** 스무스 스크롤 지속 시간 (밀리초) */
    duration?: number;
    /** 가로 스크롤 감도 */
    horizontalSensitivity?: number;
    /** 세로 스크롤 감도 */
    verticalSensitivity?: number;
    /** 러프 값 (애니메이션 부드러움) */
    lerp?: number;
    /** 휠 배율 */
    wheelMultiplier?: number;
    /** 터치 배율 */
    touchMultiplier?: number;
    /** 정밀 모드 */
    precisionMode?: boolean;
    /** 바운스 효과 */
    bounceEffect?: boolean;
    /** 플링 배율 */
    flingMultiplier?: number;
    /** 키보드 스크롤 양 */
    keyboardScrollAmount?: number;
    /** 터치 정지 임계값 */
    touchStopThreshold?: number;
    /** 하이브리드 모드 */
    hybridMode?: boolean;
    /** 대각선 스크롤 시 Y축 우선 모드 */
    prioritizeVertical?: boolean;
    /** 터치 방향 고정 모드 (대각선 터치 시 방향 고정) */
    lockTouchDirection?: boolean;
    /** 터치 방향 결정을 위한 최소 이동 거리 */
    touchDirectionThreshold?: number;
    /** 터치 방향 전환 허용 (고정된 방향에서 반대 방향으로 전환 가능) */
    allowDirectionChange?: boolean;
    /** 방향 전환을 위한 최소 이동 거리 */
    directionChangeThreshold?: number;
    /** 방향 전환 시 델타 스무딩 강도 (0-1) */
    directionChangeSmoothness?: number;
    /** 각도 기반 방향 결정 사용 여부 */
    useAngleBasedDirection?: boolean;
    /** 가로 스크롤로 인식할 최대 각도 (도 단위, 기본값: 20) */
    horizontalAngleThreshold?: number;
}
/**
 * 스크롤 라이브러리 옵션 인터페이스
 */
export interface TwoDimensionScrollOptions extends EnvironmentScrollOptions {
    /** 이징 함수 */
    easing?: (t: number) => number;
    /** 스크롤 비활성화 여부 */
    disabled?: boolean;
    /** 모바일에서 네이티브 스크롤 사용 여부 */
    useNativeScrollOnMobile?: boolean;
    /** 스크롤 가능한 요소 선택자 */
    scrollableSelector?: string;
    /** 디버그 모드 */
    debug?: boolean;
    /** 데스크톱 환경 전용 옵션 */
    desktop?: EnvironmentScrollOptions;
    /** 모바일 환경 전용 옵션 */
    mobile?: EnvironmentScrollOptions;
    /** 태블릿 환경 전용 옵션 */
    tablet?: EnvironmentScrollOptions;
}
/**
 * 스크롤 이벤트 데이터
 */
export interface ScrollEventData {
    /** 델타 X (가로 스크롤량) */
    deltaX: number;
    /** 델타 Y (세로 스크롤량) */
    deltaY: number;
    /** 현재 스크롤 위치 */
    scrollTop: number;
    /** 스크롤 방향 (-1: 위, 1: 아래) */
    direction: number;
    /** 이벤트 타입 */
    type: "wheel" | "touch" | "keyboard";
}
/**
 * 애니메이션 프레임 데이터
 */
export interface AnimationFrame {
    /** 시작 시간 */
    startTime: number;
    /** 시작 위치 */
    startPosition: number;
    /** 목표 위치 */
    targetPosition: number;
    /** 지속 시간 */
    duration: number;
    /** 이징 함수 */
    easing: (t: number) => number;
}
/**
 * 콜백 함수 타입들
 */
export type ScrollCallback = (data: ScrollEventData) => void;
export type AnimationCallback = (progress: number) => void;
/**
 * 기본 이징 함수들
 */
export declare const Easing: {
    readonly linear: (t: number) => number;
    readonly easeInQuad: (t: number) => number;
    readonly easeOutQuad: (t: number) => number;
    readonly easeInOutQuad: (t: number) => number;
    readonly easeInCubic: (t: number) => number;
    readonly easeOutCubic: (t: number) => number;
    readonly easeInOutCubic: (t: number) => number;
};
//# sourceMappingURL=types.d.ts.map