@yamada-ui/pagination 0.1.11 → 0.2.0

package/dist/index.d.ts

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

package/dist/index.js

@@ -20,7 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  Pagination: () => Pagination
+  Pagination: () => Pagination,
+  usePagination: () => usePagination
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -308,5 +309,6 @@ var Pagination = (0, import_core2.forwardRef)((props, ref) => {
 });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Pagination
+  Pagination,
+  usePagination
 });

package/dist/index.mjs

@@ -3,7 +3,10 @@ import {
 } from "./chunk-OQAHPAGR.mjs";
 import "./chunk-3JXQPHJH.mjs";
 import "./chunk-IXTXZCRI.mjs";
-import "./chunk-3KNXDAHV.mjs";
+import {
+  usePagination
+} from "./chunk-3KNXDAHV.mjs";
 export {
-  Pagination
+  Pagination,
+  usePagination
 };

package/dist/pagination-item.d.ts

@@ -1,9 +1,21 @@
 import { ComponentPropsWithoutRef, FC } from 'react';
 
-type Page = number | 'dots' | 'prev' | 'next' | 'first' | 'last';
 type PaginationItemOptions = {
-    page: Page;
+    /**
+     * 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;

package/dist/pagination.d.ts

@@ -5,15 +5,49 @@ import { PaginationItemProps } from './pagination-item.js';
 import { UsePaginationProps } from './use-pagination.js';
 
 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;

package/dist/use-pagination.d.ts

@@ -5,12 +5,42 @@ 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[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamada-ui/pagination",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "description": "Yamada UI pagination component",
   "keywords": [
     "yamada",
@@ -35,11 +35,11 @@
     "url": "https://github.com/hirotomoyamada/yamada-ui/issues"
   },
   "dependencies": {
-    "@yamada-ui/core": "0.3.0",
+    "@yamada-ui/core": "0.3.1",
     "@yamada-ui/utils": "0.1.1",
-    "@yamada-ui/icon": "0.1.11",
+    "@yamada-ui/icon": "0.2.0",
     "@yamada-ui/use-controllable-state": "0.1.2",
-    "@yamada-ui/use-value": "0.1.11"
+    "@yamada-ui/use-value": "0.1.12"
   },
   "devDependencies": {
     "react": "^18.0.0",
@@ -73,6 +73,6 @@
     "build:fast": "tsup src",
     "clean": "rimraf dist .turbo",
     "typecheck": "tsc --noEmit",
-    "gen:types": "tsx ../../../scripts/generate-types"
+    "gen:docs": "tsx ../../../scripts/generate-docs"
   }
 }