Interface PaginationOptions

interface PaginationOptions {
    totalPages: number;
    currentUserPage: number;
    handlePageChange?: ((options: GeneratePageContentOptions) => Promise<void>);
    position?: "left" | "right" | "middle";
    location?: "bottom" | "top" | "middle";
    direction?: "horizontal" | "vertical";
    buttonsContainerStyle?: CSSProperties;
    activePageStyle?: CSSProperties;
    inactivePageStyle?: CSSProperties;
    backgroundColor?: string;
    paginationHeight?: number;
    showAspect?: boolean;
    parameters: PaginationParameters;
    containerProps?: HTMLAttributes<HTMLDivElement>;
    pageButtonProps?: ((context: {
        page: number;
        isActive: boolean;
        isHomePage: boolean;
    }) => undefined | ButtonHTMLAttributes<HTMLButtonElement>);
    renderContainer?: ((options: {
        defaultContainer: ReactNode;
        pages: number[];
    }) => ReactNode);
    renderPageButton?: ((options: {
        defaultButton: ReactNode;
        page: number;
        isActive: boolean;
        isHomePage: boolean;
        onSelect: (() => Promise<void>);
        label: ReactNode;
    }) => ReactNode);
    renderPageContent?: ((options: {
        defaultContent: ReactNode;
        page: number;
        isActive: boolean;
        isHomePage: boolean;
        label: ReactNode;
    }) => ReactNode);
}

Properties

totalPages currentUserPage handlePageChange? position? location? direction? buttonsContainerStyle? activePageStyle? inactivePageStyle? backgroundColor? paginationHeight? showAspect? parameters containerProps? pageButtonProps? renderContainer? renderPageButton? renderPageContent?

Properties

totalPages

totalPages: number

currentUserPage

currentUserPage: number

OptionalhandlePageChange

handlePageChange?: ((options: GeneratePageContentOptions) => Promise<void>)

Optionalposition

position?: "left" | "right" | "middle"

Optionallocation

location?: "bottom" | "top" | "middle"

Optionaldirection

direction?: "horizontal" | "vertical"

OptionalbuttonsContainerStyle

buttonsContainerStyle?: CSSProperties

OptionalactivePageStyle

activePageStyle?: CSSProperties

OptionalinactivePageStyle

inactivePageStyle?: CSSProperties

OptionalbackgroundColor

backgroundColor?: string

OptionalpaginationHeight

paginationHeight?: number

OptionalshowAspect

showAspect?: boolean

parameters

parameters: PaginationParameters

OptionalcontainerProps

containerProps?: HTMLAttributes<HTMLDivElement>

OptionalpageButtonProps

pageButtonProps?: ((context: {
    page: number;
    isActive: boolean;
    isHomePage: boolean;
}) => undefined | ButtonHTMLAttributes<HTMLButtonElement>)

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: ReactNode;
    pages: number[];
}) => ReactNode)

OptionalrenderPageButton

renderPageButton?: ((options: {
    defaultButton: ReactNode;
    page: number;
    isActive: boolean;
    isHomePage: boolean;
    onSelect: (() => Promise<void>);
    label: ReactNode;
}) => ReactNode)

OptionalrenderPageContent

renderPageContent?: ((options: {
    defaultContent: ReactNode;
    page: number;
    isActive: boolean;
    isHomePage: boolean;
    label: ReactNode;
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties