@yamada-ui/pagination/dist/pagination.d.ts

Yamada UI pagination component

import * as _yamada_ui_core from '@yamada-ui/core';
import { HTMLUIProps, ThemeProps, Token } from '@yamada-ui/core';
import { FC } from 'react';
import { PaginationItemProps } from './pagination-item.js';
import { UsePaginationProps } from './use-pagination.js';

interface PaginationOptions {
    /**
     * The pagination button component to use.
     */
    component?: FC<PaginationItemProps>;
    /**
     * If `true`, display the control buttons.
     *
     * @default true
     */
    withControls?: Token<boolean>;
    /**
     * If `true`, display the edge buttons.
     *
     * @default false
     */
    withEdges?: Token<boolean>;
    /**
     * Props for container element.
     */
    containerProps?: HTMLUIProps<"nav">;
    /**
     * Props for next of the control button element.
     */
    controlNextProps?: Omit<PaginationItemProps, "page">;
    /**
     * Props for previous of the control button element.
     */
    controlPrevProps?: Omit<PaginationItemProps, "page">;
    /**
     * Props for control button element.
     */
    controlProps?: Omit<PaginationItemProps, "page">;
    /**
     * Props for first of the edge button element.
     */
    edgeFirstProps?: Omit<PaginationItemProps, "page">;
    /**
     * Props for last of the edge button element.
     */
    edgeLastProps?: Omit<PaginationItemProps, "page">;
    /**
     * Props for edge button element.
     */
    edgeProps?: Omit<PaginationItemProps, "page">;
    /**
     * Props for button element.
     */
    itemProps?: Omit<PaginationItemProps, "page">;
}
interface PaginationProps extends Omit<HTMLUIProps<"ul">, "children" | "onChange" | "page">, ThemeProps<"Pagination">, UsePaginationProps, PaginationOptions {
}
/**
 * `Pagination` is a component for managing the pagination and navigation of content.
 *
 * @see Docs https://yamada-ui.com/components/navigation/pagination
 */
declare const Pagination: _yamada_ui_core.Component<"ul", PaginationProps>;

export { Pagination, type PaginationProps };