dgz-ui/dist/types/ui/pagination/pagination.d.ts

Custom ui library using React.js, Shadcn/ui, TailwindCSS, Typescript

import { ButtonProps } from '../button';
import * as React from 'react';
/**
 * Pagination - Navigation component for paginated content.
 * @returns {JSX.Element} The rendered Pagination component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination component.
 */
declare const Pagination: {
    ({ className, ...props }: React.ComponentProps<"nav">): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
/**
 * PaginationContent - Wrapper list for pagination items.
 * @returns {JSX.Element} The rendered PaginationContent component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination content component.
 */
declare const PaginationContent: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref"> & React.RefAttributes<HTMLUListElement>>;
/**
 * PaginationItem - List item wrapper.
 * @returns {JSX.Element} The rendered PaginationItem component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination item component.
 */
declare const PaginationItem: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & React.RefAttributes<HTMLLIElement>>;
/**
 * Props for PaginationLink.
 * @property {boolean} [isActive] - Marks the current page.
 * @property {'lg'|'default'|'sm'|'xs'|'icon'} [size] - Button size forwarded to Button variants.
 */
type PaginationLinkProps = {
    isActive?: boolean;
} & Pick<ButtonProps, 'size'> & React.ComponentProps<'a'>;
/**
 * PaginationLink - A styled anchor used as a pagination control.
 * @returns {JSX.Element} The rendered PaginationLink component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination link component.
 * @param {boolean} [props.isActive] - Marks the current page.
 * @param {string} [props.size] - The size of the pagination link.
 */
declare const PaginationLink: {
    ({ className, isActive, size, ...props }: PaginationLinkProps): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
/**
 * PaginationPrevious - Button to navigate to previous page.
 * @returns {JSX.Element} The rendered PaginationPrevious component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination previous component.
 */
declare const PaginationPrevious: {
    ({ className, ...props }: React.ComponentProps<typeof PaginationLink>): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
/**
 * PaginationNext - Button to navigate to next page.
 * @returns {JSX.Element} The rendered PaginationNext component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination next component.
 */
declare const PaginationNext: {
    ({ className, ...props }: React.ComponentProps<typeof PaginationLink>): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
/**
 * PaginationEllipsis - Non-interactive indicator for collapsed pages.
 * @returns {JSX.Element} The rendered PaginationEllipsis component.
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the pagination ellipsis component.
 */
declare const PaginationEllipsis: {
    ({ className, ...props }: React.ComponentProps<"span">): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
export { Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious, };
//# sourceMappingURL=pagination.d.ts.map