@types/lucasmogari__react-pagination v0.0.5

Installation

npm install --save @types/lucasmogari__react-pagination

Summary

This package contains type definitions for @lucasmogari/react-navigation (https://github.com/lucasmogari/react-pagination).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lucasmogari__react-pagination.

index.d.ts

// Type definitions for @lucasmogari/react-navigation 0.0
// Project: https://github.com/lucasmogari/react-pagination
// Definitions by: Laura Beatris <https://github.com/LauraBeatris>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import * as React from 'react';

export interface UseNavigationParameters {
    page?: number | undefined;
    arrows?: boolean | undefined;
    numbers?: boolean | undefined;
    totalItems: number;
    itemsPerPage: number;
    maxPageItems?: number | undefined;
    getPageItemProps: (...parameters: any[]) => void;
}

export enum PageVariant {
    'before' = 'before',
    'next' = 'next',
    'gap' = 'gap',
}

export interface PageItemProps {
    disabled?: boolean | undefined;
    'aria-current'?: boolean | undefined;
    onClick: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
}

export interface PageItem {
    current?: boolean | undefined;
    disabled?: boolean | undefined;
    props: PageItemProps;
    page: PageVariant | number;
}

export type Page = PageVariant | number;

export interface UseNavigationPayload {
    page: number;
    size: number;
    goTo: (page: Page) => void;
    next: () => void;
    arrows: boolean;
    toItem: number;
    numbers: boolean;
    previous: () => void;
    fromItem: number;
    totalItems: number;
    totalPages: number;
    getPageItem: (pageIndex: number) => PageItem;
    itemsPerPage: number;
    maxPageItems: number;
    setTotalItems: (totalItem: number) => void;
    setMaxPageItems: (maxPageItems: number) => void;
}

export function useNavigation(parameters: UseNavigationParameters): UseNavigationPayload;

Additional Details

• Last updated: Thu, 08 Jul 2021 16:23:52 GMT
• Dependencies: @types/react
• Global values: none

Credits

These definitions were written by Laura Beatris.