@nori-ui/core 0.0.5 → 1.0.2

package/dist/components/Pagination/index.d.cts

@@ -0,0 +1,164 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode, FC } from 'react';
+
+type PaginationItemType = 'page' | 'prev' | 'next' | 'first' | 'last' | 'ellipsis';
+/**
+ * One slot in the rendered pagination row, as produced by `usePagination`.
+ * `page` is set on `'page'` items only; ellipsis carries no number.
+ */
+type PaginationItemDescriptor = {
+    type: PaginationItemType;
+    page?: number;
+    selected?: boolean;
+    disabled?: boolean;
+};
+type UsePaginationArgs = {
+    /** Controlled current page (1-indexed). Omit for uncontrolled. */
+    page?: number;
+    /** Initial page when uncontrolled (1-indexed). @defaultValue 1 */
+    defaultPage?: number;
+    /** Total number of pages. */
+    pageCount: number;
+    /** Pages on each side of the current page. @defaultValue 1 */
+    siblingCount?: number;
+    /** Pages always visible at start/end. @defaultValue 1 */
+    boundaryCount?: number;
+    /** Include first/last items in the `pages` list. @defaultValue false */
+    showFirstLast?: boolean;
+    /** Include prev/next items in the `pages` list. @defaultValue true */
+    showPrevNext?: boolean;
+    /** Fired on every page change. */
+    onPageChange?: (page: number) => void;
+};
+type UsePaginationReturn = {
+    /** Current page (1-indexed), clamped to [1, max(1, pageCount)]. */
+    page: number;
+    /** Item descriptors in render order. */
+    pages: ReadonlyArray<PaginationItemDescriptor>;
+    canPrev: boolean;
+    canNext: boolean;
+    goToPage: (page: number) => void;
+    prev: () => void;
+    next: () => void;
+    first: () => void;
+    last: () => void;
+};
+/**
+ * Headless pagination math + state. Returns the items to render and the
+ * actions that drive them — without a single DOM/RN element. Use this
+ * directly for fully custom paginators, or let `<Pagination>` use it
+ * internally.
+ *
+ * The math mirrors MUI's `usePagination` algorithm so its behavior is
+ * predictable for anyone who has used the React ecosystem before.
+ *
+ * @example
+ * const p = usePagination({ pageCount: 12, defaultPage: 3 });
+ * p.pages.map((item) => …);
+ */
+declare function usePagination(args: UsePaginationArgs): UsePaginationReturn;
+
+type PaginationVariant = 'auto' | 'numbered' | 'compact';
+type PaginationRenderItemArgs = {
+    type: PaginationItemType;
+    page?: number;
+    selected: boolean;
+    disabled: boolean;
+    ariaLabel: string;
+    ariaCurrent?: 'page';
+    children: ReactNode;
+    onPress: () => void;
+};
+type PaginationOnPageChange = (page: number, meta?: {
+    pageSize?: number;
+}) => void;
+type PaginationProps = {
+    /** Controlled current page (1-indexed). */
+    page?: number;
+    /** Initial page when uncontrolled (1-indexed). @defaultValue 1 */
+    defaultPage?: number;
+    /** Total number of pages. Required. */
+    pageCount: number;
+    /** Pages on each side of the current page. @defaultValue 1 */
+    siblingCount?: number;
+    /** Pages always visible at start/end. @defaultValue 1 */
+    boundaryCount?: number;
+    /** Show first/last buttons. @defaultValue false */
+    showFirstLast?: boolean;
+    /** Hide the entire component when `pageCount <= 1`. @defaultValue true */
+    hideOnSinglePage?: boolean;
+    /**
+     * Force a UI variant. `auto` swaps to `compact` on viewports under
+     * `PAGINATION_COMPACT_BREAKPOINT` px wide.
+     * @defaultValue 'auto'
+     */
+    variant?: PaginationVariant;
+    /** Render the "Showing X–Y of Z" range automatically. @defaultValue false */
+    showRange?: boolean;
+    /** Total item count — needed by `Pagination.Range` and `Pagination.PageSize`. */
+    itemCount?: number;
+    /** Items per page — needed by `Pagination.Range` and `Pagination.PageSize`. */
+    pageSize?: number;
+    /** Fired on every page (or page-size) change. */
+    onPageChange?: PaginationOnPageChange;
+    /** Render-prop slot for each item. Same signature on web + native. */
+    renderItem?: (args: PaginationRenderItemArgs) => ReactNode;
+    /** RTL override. @defaultValue 'ltr' */
+    dir?: 'ltr' | 'rtl';
+    /** Override individual labels (otherwise sourced from `useTranslation`). */
+    previousLabel?: string;
+    nextLabel?: string;
+    firstLabel?: string;
+    lastLabel?: string;
+    /** Override the nav landmark label. */
+    ariaLabel?: string;
+    className?: string;
+    testID?: string;
+    /** Provide compound children to opt out of the items-array shorthand. */
+    children?: ReactNode;
+};
+/** Viewport width below which `variant="auto"` switches to `compact`. */
+declare const PAGINATION_COMPACT_BREAKPOINT = 480;
+type CompoundButtonProps = {
+    asChild?: boolean;
+    children?: ReactNode;
+    testID?: string;
+};
+type PaginationJumperProps = {
+    /** Show a separate visible "Go to page" label before the input. The aria-label is always set regardless. @defaultValue false */
+    showLabel?: boolean;
+    /** Override the visible label / accessible name. */
+    label?: string;
+    /** Override the input placeholder. @defaultValue the localized "Go to" hint */
+    placeholder?: string;
+    /** Width of the input in px. @defaultValue 56 */
+    inputWidth?: number;
+    testID?: string;
+};
+
+declare const Pagination: ((props: PaginationProps) => react_jsx_runtime.JSX.Element | null) & {
+    Items: FC<{
+        children?: ReactNode;
+    }>;
+    Item: FC<{
+        page: number;
+        asChild?: boolean;
+        children?: ReactNode;
+        testID?: string;
+    }>;
+    Prev: FC<CompoundButtonProps>;
+    Next: FC<CompoundButtonProps>;
+    First: FC<CompoundButtonProps>;
+    Last: FC<CompoundButtonProps>;
+    Ellipsis: FC<{
+        children?: ReactNode;
+    }>;
+    Range: FC;
+    PageSize: FC<{
+        options: ReadonlyArray<number>;
+        testID?: string;
+    }>;
+    Jumper: FC<PaginationJumperProps>;
+};
+
+export { PAGINATION_COMPACT_BREAKPOINT, Pagination, type PaginationItemDescriptor, type PaginationItemType, type PaginationJumperProps, type PaginationOnPageChange, type PaginationProps, type PaginationRenderItemArgs, type PaginationVariant, type UsePaginationArgs, type UsePaginationReturn, usePagination };

package/dist/components/Pagination/index.d.ts

@@ -0,0 +1,164 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode, FC } from 'react';
+
+type PaginationItemType = 'page' | 'prev' | 'next' | 'first' | 'last' | 'ellipsis';
+/**
+ * One slot in the rendered pagination row, as produced by `usePagination`.
+ * `page` is set on `'page'` items only; ellipsis carries no number.
+ */
+type PaginationItemDescriptor = {
+    type: PaginationItemType;
+    page?: number;
+    selected?: boolean;
+    disabled?: boolean;
+};
+type UsePaginationArgs = {
+    /** Controlled current page (1-indexed). Omit for uncontrolled. */
+    page?: number;
+    /** Initial page when uncontrolled (1-indexed). @defaultValue 1 */
+    defaultPage?: number;
+    /** Total number of pages. */
+    pageCount: number;
+    /** Pages on each side of the current page. @defaultValue 1 */
+    siblingCount?: number;
+    /** Pages always visible at start/end. @defaultValue 1 */
+    boundaryCount?: number;
+    /** Include first/last items in the `pages` list. @defaultValue false */
+    showFirstLast?: boolean;
+    /** Include prev/next items in the `pages` list. @defaultValue true */
+    showPrevNext?: boolean;
+    /** Fired on every page change. */
+    onPageChange?: (page: number) => void;
+};
+type UsePaginationReturn = {
+    /** Current page (1-indexed), clamped to [1, max(1, pageCount)]. */
+    page: number;
+    /** Item descriptors in render order. */
+    pages: ReadonlyArray<PaginationItemDescriptor>;
+    canPrev: boolean;
+    canNext: boolean;
+    goToPage: (page: number) => void;
+    prev: () => void;
+    next: () => void;
+    first: () => void;
+    last: () => void;
+};
+/**
+ * Headless pagination math + state. Returns the items to render and the
+ * actions that drive them — without a single DOM/RN element. Use this
+ * directly for fully custom paginators, or let `<Pagination>` use it
+ * internally.
+ *
+ * The math mirrors MUI's `usePagination` algorithm so its behavior is
+ * predictable for anyone who has used the React ecosystem before.
+ *
+ * @example
+ * const p = usePagination({ pageCount: 12, defaultPage: 3 });
+ * p.pages.map((item) => …);
+ */
+declare function usePagination(args: UsePaginationArgs): UsePaginationReturn;
+
+type PaginationVariant = 'auto' | 'numbered' | 'compact';
+type PaginationRenderItemArgs = {
+    type: PaginationItemType;
+    page?: number;
+    selected: boolean;
+    disabled: boolean;
+    ariaLabel: string;
+    ariaCurrent?: 'page';
+    children: ReactNode;
+    onPress: () => void;
+};
+type PaginationOnPageChange = (page: number, meta?: {
+    pageSize?: number;
+}) => void;
+type PaginationProps = {
+    /** Controlled current page (1-indexed). */
+    page?: number;
+    /** Initial page when uncontrolled (1-indexed). @defaultValue 1 */
+    defaultPage?: number;
+    /** Total number of pages. Required. */
+    pageCount: number;
+    /** Pages on each side of the current page. @defaultValue 1 */
+    siblingCount?: number;
+    /** Pages always visible at start/end. @defaultValue 1 */
+    boundaryCount?: number;
+    /** Show first/last buttons. @defaultValue false */
+    showFirstLast?: boolean;
+    /** Hide the entire component when `pageCount <= 1`. @defaultValue true */
+    hideOnSinglePage?: boolean;
+    /**
+     * Force a UI variant. `auto` swaps to `compact` on viewports under
+     * `PAGINATION_COMPACT_BREAKPOINT` px wide.
+     * @defaultValue 'auto'
+     */
+    variant?: PaginationVariant;
+    /** Render the "Showing X–Y of Z" range automatically. @defaultValue false */
+    showRange?: boolean;
+    /** Total item count — needed by `Pagination.Range` and `Pagination.PageSize`. */
+    itemCount?: number;
+    /** Items per page — needed by `Pagination.Range` and `Pagination.PageSize`. */
+    pageSize?: number;
+    /** Fired on every page (or page-size) change. */
+    onPageChange?: PaginationOnPageChange;
+    /** Render-prop slot for each item. Same signature on web + native. */
+    renderItem?: (args: PaginationRenderItemArgs) => ReactNode;
+    /** RTL override. @defaultValue 'ltr' */
+    dir?: 'ltr' | 'rtl';
+    /** Override individual labels (otherwise sourced from `useTranslation`). */
+    previousLabel?: string;
+    nextLabel?: string;
+    firstLabel?: string;
+    lastLabel?: string;
+    /** Override the nav landmark label. */
+    ariaLabel?: string;
+    className?: string;
+    testID?: string;
+    /** Provide compound children to opt out of the items-array shorthand. */
+    children?: ReactNode;
+};
+/** Viewport width below which `variant="auto"` switches to `compact`. */
+declare const PAGINATION_COMPACT_BREAKPOINT = 480;
+type CompoundButtonProps = {
+    asChild?: boolean;
+    children?: ReactNode;
+    testID?: string;
+};
+type PaginationJumperProps = {
+    /** Show a separate visible "Go to page" label before the input. The aria-label is always set regardless. @defaultValue false */
+    showLabel?: boolean;
+    /** Override the visible label / accessible name. */
+    label?: string;
+    /** Override the input placeholder. @defaultValue the localized "Go to" hint */
+    placeholder?: string;
+    /** Width of the input in px. @defaultValue 56 */
+    inputWidth?: number;
+    testID?: string;
+};
+
+declare const Pagination: ((props: PaginationProps) => react_jsx_runtime.JSX.Element | null) & {
+    Items: FC<{
+        children?: ReactNode;
+    }>;
+    Item: FC<{
+        page: number;
+        asChild?: boolean;
+        children?: ReactNode;
+        testID?: string;
+    }>;
+    Prev: FC<CompoundButtonProps>;
+    Next: FC<CompoundButtonProps>;
+    First: FC<CompoundButtonProps>;
+    Last: FC<CompoundButtonProps>;
+    Ellipsis: FC<{
+        children?: ReactNode;
+    }>;
+    Range: FC;
+    PageSize: FC<{
+        options: ReadonlyArray<number>;
+        testID?: string;
+    }>;
+    Jumper: FC<PaginationJumperProps>;
+};
+
+export { PAGINATION_COMPACT_BREAKPOINT, Pagination, type PaginationItemDescriptor, type PaginationItemType, type PaginationJumperProps, type PaginationOnPageChange, type PaginationProps, type PaginationRenderItemArgs, type PaginationVariant, type UsePaginationArgs, type UsePaginationReturn, usePagination };

package/dist/components/Pagination/index.js

@@ -0,0 +1,12 @@
+export { PAGINATION_COMPACT_BREAKPOINT, Pagination, usePagination } from '../../chunk-7GPDNQSX.js';
+import '../../chunk-ZQMNGPLE.js';
+import '../../chunk-RFW5SRZA.js';
+import '../../chunk-FT2XBBQJ.js';
+import '../../chunk-7Z4NMNX6.js';
+import '../../chunk-ZIBNLXIV.js';
+import '../../chunk-5A2QOOVN.js';
+import '../../chunk-CHXHRJNZ.js';
+import '../../chunk-R5JMDDCB.js';
+import '../../chunk-WCQVDF3K.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/components/Pagination/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}