@procore/core-react/dist/_hooks/ListNavigation.d.ts

React library of Procore Design Guidelines

/**
 * @deprecatedSince 9
 * @deprecated Never officially documented/supported
 */
export interface ListNavigationConfig {
    circular?: boolean;
    initialIndex?: number;
    size?: number;
}
/**
 * @deprecatedSince 9
 * @deprecated Never officially documented/supported
 */
export interface ListNavigationApi {
    clear: () => void;
    decrement: () => void;
    decrementBy: (amount: number) => void;
    increment: () => void;
    incrementBy: (amount: number) => void;
    index: number;
    reset: () => void;
    set: (index: number) => void;
    setSize: (index: number) => void;
    size: number;
}
interface RenderProps extends ListNavigationConfig {
    children: (props: ListNavigationApi) => {};
}
/**
 * @deprecatedSince 9
 * @deprecated Never officially documented/supported
 */
export declare function useListNavigation({ circular, initialIndex, size: initialSize, }: ListNavigationConfig): ListNavigationApi;
/**
 * @deprecatedSince 9
 * @deprecated Never officially documented/supported
 */
export declare function ListNavigation({ children, ...props }: RenderProps): {};
export {};