fullpage-scroll-component
Version:
Stepped Scroll Component Library.
51 lines (50 loc) • 1.46 kB
TypeScript
import { Dispatch, SetStateAction } from "react";
interface useSuccessiveValueArgs {
/**
* 시작 숫자를 지정합니다.
*/
defaultNumber?: number;
/**
* 최대번호를 지정합니다.
* 최대번호가 넘어가면 next, prev 함수가 동작하지 않습니다.
*/
maximum: number;
}
export interface useSuccessiveValueReturnType {
/**
* 현재 번호 입니다.
*/
current: number;
/**
* 현재 번호를 변형시키는 dispatch 입니다.
*/
setCurrent: Dispatch<SetStateAction<number>>;
/**
* 디폴트 값으로 초기화 하는 함수입니다.
*/
resetCurrent: () => void;
/**
* 다음 번호로 변화시키는 함수입니다.
* @returns 함수가 실행된 이후 인덱스 값을 반환합니다.
*/
next: () => number;
/**
* 이전 번호로 변화시키는 함수입니다.
* @returns 함수가 실행된 이후 인덱스 값을 반환합니다.
*/
prev: () => number;
/**
* 다음 번호가 있는지 여부를 나타냅니다.
*/
hasNext: boolean;
/**
* 이전 번호가 있는지 여부를 나타냅니다.
*/
hasPrev: boolean;
/**
* 특정 값으로 변형시킵니다.
*/
move: (to: number) => void;
}
export declare const useSuccessiveValue: ({ defaultNumber, maximum, }: useSuccessiveValueArgs) => useSuccessiveValueReturnType;
export {};