@zentauri-ui/zentauri-components 0.0.83 → 0.0.91

package/dist/ui/pagination.d.cts

@@ -0,0 +1,114 @@
+import * as class_variance_authority from 'class-variance-authority';
+import { VariantProps } from 'class-variance-authority';
+import * as class_variance_authority_types from 'class-variance-authority/types';
+import * as react from 'react';
+import { ComponentPropsWithoutRef } from 'react';
+import { b as buttonVariants } from '../variants-1Bx3BEeS.cjs';
+
+declare const Pagination: react.ForwardRefExoticComponent<Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLElement>, HTMLElement>, "ref">, "onChange"> & class_variance_authority.VariantProps<(props?: ({
+    appearance?: "default" | "outline" | "link" | "ghost" | "sky" | "rose" | "purple" | "pink" | "orange" | "yellow" | "teal" | "indigo" | "emerald" | "gradient-blue" | "gradient-green" | "gradient-red" | "gradient-yellow" | "gradient-purple" | "gradient-teal" | "gradient-indigo" | "gradient-pink" | "gradient-orange" | "gray" | "violet" | "secondary" | "destructive" | "glass" | "amber" | null | undefined;
+    size?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "icon" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string> & {
+    pageCount: number;
+    page?: number;
+    defaultPage?: number;
+    onPageChange?: (page: number) => void;
+    siblingCount?: number;
+    boundaryCount?: number;
+    showPrevNext?: boolean;
+    prevLabel?: string;
+    nextLabel?: string;
+    ellipsisLabel?: string;
+    getPageHref?: (page: number) => string | undefined;
+} & react.RefAttributes<HTMLElement>>;
+
+type PaginationPageItem$1 = {
+    type: "page";
+    value: number;
+} | {
+    type: "ellipsis";
+    key: string;
+};
+type BuildPaginationItemsParams = {
+    pageCount: number;
+    currentPage: number;
+    siblingCount: number;
+    boundaryCount: number;
+};
+/**
+ * Builds the ordered list of page numbers and ellipsis markers for a pagination control.
+ *
+ * Args:
+ *   pageCount: Total number of pages (must be >= 0).
+ *   currentPage: Active page index (1-based).
+ *   siblingCount: How many page buttons to show on each side of the current page.
+ *   boundaryCount: How many pages to pin at the start and end of the range.
+ *
+ * Returns:
+ *   A list of items suitable for rendering, e.g. [1, ellipsis, 4,5,6, ellipsis, 20].
+ */
+declare function buildPaginationItems({ pageCount, currentPage, siblingCount, boundaryCount, }: BuildPaginationItemsParams): PaginationPageItem$1[];
+declare function clampPage(page: number, pageCount: number): number;
+
+type PaginationAppearance = NonNullable<VariantProps<typeof buttonVariants>["appearance"]>;
+type PaginationSize = NonNullable<VariantProps<typeof buttonVariants>["size"]>;
+type PaginationPageItem = PaginationPageItem$1;
+type UsePaginationParams = {
+    pageCount: number;
+    page?: number;
+    defaultPage?: number;
+    siblingCount?: number;
+    boundaryCount?: number;
+    onPageChange?: (page: number) => void;
+};
+type UsePaginationResult = {
+    /** 1-based active page, clamped to `[1, pageCount]`. */
+    currentPage: number;
+    pageCount: number;
+    items: PaginationPageItem[];
+    setPage: (page: number) => void;
+    goPrev: () => void;
+    goNext: () => void;
+    canGoPrev: boolean;
+    canGoNext: boolean;
+};
+type PaginationProps = Omit<ComponentPropsWithoutRef<"nav">, "onChange"> & VariantProps<typeof buttonVariants> & {
+    pageCount: number;
+    page?: number;
+    defaultPage?: number;
+    onPageChange?: (page: number) => void;
+    /**
+     * Number of page buttons to show on each side of the current page (the “middle” window).
+     * @defaultValue 1
+     */
+    siblingCount?: number;
+    /**
+     * Number of pages to keep visible at the start and end of the range.
+     * @defaultValue 1
+     */
+    boundaryCount?: number;
+    showPrevNext?: boolean;
+    prevLabel?: string;
+    nextLabel?: string;
+    ellipsisLabel?: string;
+    /**
+     * When set, page controls render as anchors suitable for URL-based pagination.
+     */
+    getPageHref?: (page: number) => string | undefined;
+};
+
+declare function usePagination({ pageCount, page, defaultPage, siblingCount, boundaryCount, onPageChange, }: UsePaginationParams): UsePaginationResult;
+
+/**
+ * Layout and chrome for the page list cluster. Appearance and size keys align with
+ * `components/ui/buttons/variants.ts` for consistent design-system tokens.
+ */
+declare const paginationListVariants: (props?: ({
+    appearance?: "default" | "outline" | "link" | "ghost" | "sky" | "rose" | "purple" | "pink" | "orange" | "yellow" | "teal" | "indigo" | "emerald" | "gradient-blue" | "gradient-green" | "gradient-red" | "gradient-yellow" | "gradient-purple" | "gradient-teal" | "gradient-indigo" | "gradient-pink" | "gradient-orange" | "gray" | "violet" | "secondary" | "destructive" | "glass" | "amber" | null | undefined;
+    size?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "icon" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+declare const paginationEllipsisVariants: (props?: ({
+    size?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "icon" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+
+export { Pagination, type PaginationAppearance, type PaginationPageItem, type PaginationProps, type PaginationSize, type UsePaginationParams, type UsePaginationResult, buildPaginationItems, clampPage, paginationEllipsisVariants, paginationListVariants, usePagination };

package/dist/ui/pagination.d.ts

@@ -0,0 +1,114 @@
+import * as class_variance_authority from 'class-variance-authority';
+import { VariantProps } from 'class-variance-authority';
+import * as class_variance_authority_types from 'class-variance-authority/types';
+import * as react from 'react';
+import { ComponentPropsWithoutRef } from 'react';
+import { b as buttonVariants } from '../variants-1Bx3BEeS.js';
+
+declare const Pagination: react.ForwardRefExoticComponent<Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLElement>, HTMLElement>, "ref">, "onChange"> & class_variance_authority.VariantProps<(props?: ({
+    appearance?: "default" | "outline" | "link" | "ghost" | "sky" | "rose" | "purple" | "pink" | "orange" | "yellow" | "teal" | "indigo" | "emerald" | "gradient-blue" | "gradient-green" | "gradient-red" | "gradient-yellow" | "gradient-purple" | "gradient-teal" | "gradient-indigo" | "gradient-pink" | "gradient-orange" | "gray" | "violet" | "secondary" | "destructive" | "glass" | "amber" | null | undefined;
+    size?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "icon" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string> & {
+    pageCount: number;
+    page?: number;
+    defaultPage?: number;
+    onPageChange?: (page: number) => void;
+    siblingCount?: number;
+    boundaryCount?: number;
+    showPrevNext?: boolean;
+    prevLabel?: string;
+    nextLabel?: string;
+    ellipsisLabel?: string;
+    getPageHref?: (page: number) => string | undefined;
+} & react.RefAttributes<HTMLElement>>;
+
+type PaginationPageItem$1 = {
+    type: "page";
+    value: number;
+} | {
+    type: "ellipsis";
+    key: string;
+};
+type BuildPaginationItemsParams = {
+    pageCount: number;
+    currentPage: number;
+    siblingCount: number;
+    boundaryCount: number;
+};
+/**
+ * Builds the ordered list of page numbers and ellipsis markers for a pagination control.
+ *
+ * Args:
+ *   pageCount: Total number of pages (must be >= 0).
+ *   currentPage: Active page index (1-based).
+ *   siblingCount: How many page buttons to show on each side of the current page.
+ *   boundaryCount: How many pages to pin at the start and end of the range.
+ *
+ * Returns:
+ *   A list of items suitable for rendering, e.g. [1, ellipsis, 4,5,6, ellipsis, 20].
+ */
+declare function buildPaginationItems({ pageCount, currentPage, siblingCount, boundaryCount, }: BuildPaginationItemsParams): PaginationPageItem$1[];
+declare function clampPage(page: number, pageCount: number): number;
+
+type PaginationAppearance = NonNullable<VariantProps<typeof buttonVariants>["appearance"]>;
+type PaginationSize = NonNullable<VariantProps<typeof buttonVariants>["size"]>;
+type PaginationPageItem = PaginationPageItem$1;
+type UsePaginationParams = {
+    pageCount: number;
+    page?: number;
+    defaultPage?: number;
+    siblingCount?: number;
+    boundaryCount?: number;
+    onPageChange?: (page: number) => void;
+};
+type UsePaginationResult = {
+    /** 1-based active page, clamped to `[1, pageCount]`. */
+    currentPage: number;
+    pageCount: number;
+    items: PaginationPageItem[];
+    setPage: (page: number) => void;
+    goPrev: () => void;
+    goNext: () => void;
+    canGoPrev: boolean;
+    canGoNext: boolean;
+};
+type PaginationProps = Omit<ComponentPropsWithoutRef<"nav">, "onChange"> & VariantProps<typeof buttonVariants> & {
+    pageCount: number;
+    page?: number;
+    defaultPage?: number;
+    onPageChange?: (page: number) => void;
+    /**
+     * Number of page buttons to show on each side of the current page (the “middle” window).
+     * @defaultValue 1
+     */
+    siblingCount?: number;
+    /**
+     * Number of pages to keep visible at the start and end of the range.
+     * @defaultValue 1
+     */
+    boundaryCount?: number;
+    showPrevNext?: boolean;
+    prevLabel?: string;
+    nextLabel?: string;
+    ellipsisLabel?: string;
+    /**
+     * When set, page controls render as anchors suitable for URL-based pagination.
+     */
+    getPageHref?: (page: number) => string | undefined;
+};
+
+declare function usePagination({ pageCount, page, defaultPage, siblingCount, boundaryCount, onPageChange, }: UsePaginationParams): UsePaginationResult;
+
+/**
+ * Layout and chrome for the page list cluster. Appearance and size keys align with
+ * `components/ui/buttons/variants.ts` for consistent design-system tokens.
+ */
+declare const paginationListVariants: (props?: ({
+    appearance?: "default" | "outline" | "link" | "ghost" | "sky" | "rose" | "purple" | "pink" | "orange" | "yellow" | "teal" | "indigo" | "emerald" | "gradient-blue" | "gradient-green" | "gradient-red" | "gradient-yellow" | "gradient-purple" | "gradient-teal" | "gradient-indigo" | "gradient-pink" | "gradient-orange" | "gray" | "violet" | "secondary" | "destructive" | "glass" | "amber" | null | undefined;
+    size?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "icon" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+declare const paginationEllipsisVariants: (props?: ({
+    size?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "icon" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+
+export { Pagination, type PaginationAppearance, type PaginationPageItem, type PaginationProps, type PaginationSize, type UsePaginationParams, type UsePaginationResult, buildPaginationItems, clampPage, paginationEllipsisVariants, paginationListVariants, usePagination };