@yamada-ui/pagination 0.2.4 → 0.2.6

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+export { Pagination, PaginationProps } from './pagination.mjs';
+export { UsePaginationProps, UsePaginationReturn, usePagination } from './use-pagination.mjs';
+import '@yamada-ui/core';
+import 'react';
+import './pagination-item.mjs';

package/dist/pagination-icon.d.mts

@@ -0,0 +1,10 @@
+import { IconProps } from '@yamada-ui/icon';
+import { FC } from 'react';
+
+declare const DotsIcon: FC<IconProps>;
+declare const FirstIcon: FC<IconProps>;
+declare const LastIcon: FC<IconProps>;
+declare const PrevIcon: FC<IconProps>;
+declare const NextIcon: FC<IconProps>;
+
+export { DotsIcon, FirstIcon, LastIcon, NextIcon, PrevIcon };

package/dist/pagination-item.d.mts

@@ -0,0 +1,24 @@
+import { ComponentPropsWithoutRef, FC } from 'react';
+
+type PaginationItemOptions = {
+    /**
+     * The type of the page or item assigned to the pagination item.
+     */
+    page: number | 'dots' | 'prev' | 'next' | 'first' | 'last';
+    /**
+     * If `true`, the pagination item will be actived.
+     *
+     * @default false
+     */
+    isActive?: boolean;
+    /**
+     * If `true`, the pagination item will be disabled.
+     *
+     * @default false
+     */
+    isDisabled?: boolean;
+};
+type PaginationItemProps = ComponentPropsWithoutRef<'button'> & PaginationItemOptions;
+declare const PaginationItem: FC<PaginationItemProps>;
+
+export { PaginationItem, PaginationItemProps };

package/dist/pagination.d.mts

@@ -0,0 +1,56 @@
+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.mjs';
+import { UsePaginationProps } from './use-pagination.mjs';
+
+type PaginationOptions = {
+    /**
+     * The pagination button component to use.
+     */
+    component?: FC<PaginationItemProps>;
+    /**
+     * Props for button element.
+     */
+    itemProps?: HTMLUIProps<'button'>;
+    /**
+     * If `true`, display the control buttons.
+     *
+     * @default true
+     */
+    withControls?: Token<boolean>;
+    /**
+     * Props for control button element.
+     */
+    controlProps?: HTMLUIProps<'button'>;
+    /**
+     * Props for previous of the control button element.
+     */
+    controlPrevProps?: HTMLUIProps<'button'>;
+    /**
+     * Props for next of the control button element.
+     */
+    controlNextProps?: HTMLUIProps<'button'>;
+    /**
+     * If `true`, display the edge buttons.
+     *
+     * @default false
+     */
+    withEdges?: Token<boolean>;
+    /**
+     * Props for edge button element.
+     */
+    edgeProps?: HTMLUIProps<'button'>;
+    /**
+     * Props for first of the edge button element.
+     */
+    edgeFirstProps?: HTMLUIProps<'button'>;
+    /**
+     * Props for last of the edge button element.
+     */
+    edgeLastProps?: HTMLUIProps<'button'>;
+};
+type PaginationProps = Omit<HTMLUIProps<'div'>, 'onChange' | 'children'> & ThemeProps<'Pagination'> & UsePaginationProps & PaginationOptions;
+declare const Pagination: _yamada_ui_core.Component<"div", PaginationProps>;
+
+export { Pagination, PaginationProps };

package/dist/use-pagination.d.mts

@@ -0,0 +1,60 @@
+import * as react from 'react';
+import { Token, CSSUIObject } from '@yamada-ui/core';
+
+type PaginationContext = Record<string, CSSUIObject>;
+declare const PaginationProvider: react.Provider<PaginationContext>;
+declare const usePaginationContext: () => PaginationContext;
+type UsePaginationProps = {
+    /**
+     * The page of the pagination.
+     * Should be less than `total` and greater than `1`.
+     */
+    page?: number;
+    /**
+     * The initial page of the pagination.
+     * Should be less than `total` and greater than `1`.
+     *
+     * @default 1
+     */
+    defaultPage?: number;
+    /**
+     * The total number of pages in pagination.
+     */
+    total: number;
+    /** Number of siblings displayed on the left/right side of selected page.
+     *
+     * @default 1
+     */
+    siblings?: Token<number>;
+    /**
+     * Number of elements visible on the left/right edges.
+     *
+     * @default 1
+     */
+    boundaries?: Token<number>;
+    /**
+     * If `true`, the pagination all item will be disabled.
+     *
+     * @default false
+     */
+    isDisabled?: boolean;
+    /**
+     * The callback invoked when the page changes.
+     */
+    onChange?: (page: number) => void;
+};
+declare const computedRange: (start: number, end: number) => number[];
+declare const usePagination: ({ page, defaultPage, total, siblings, boundaries, isDisabled, ...rest }: UsePaginationProps) => {
+    currentPage: number;
+    total: number;
+    isDisabled: boolean;
+    onFirst: () => void;
+    onLast: () => void;
+    onPrev: () => void;
+    onNext: () => void;
+    onChange: (page: number) => void;
+    range: (number | "dots")[];
+};
+type UsePaginationReturn = ReturnType<typeof usePagination>;
+
+export { PaginationProvider, UsePaginationProps, UsePaginationReturn, computedRange, usePagination, usePaginationContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamada-ui/pagination",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Yamada UI pagination component",
   "keywords": [
     "yamada",
@@ -35,11 +35,11 @@
     "url": "https://github.com/hirotomoyamada/yamada-ui/issues"
   },
   "dependencies": {
-    "@yamada-ui/core": "0.4.3",
-    "@yamada-ui/utils": "0.1.2",
-    "@yamada-ui/icon": "0.2.4",
-    "@yamada-ui/use-controllable-state": "0.1.3",
-    "@yamada-ui/use-value": "0.1.16"
+    "@yamada-ui/core": "0.5.1",
+    "@yamada-ui/utils": "0.1.3",
+    "@yamada-ui/icon": "0.2.6",
+    "@yamada-ui/use-controllable-state": "0.1.4",
+    "@yamada-ui/use-value": "0.1.18"
   },
   "devDependencies": {
     "react": "^18.0.0",