@sytechui/use-pagination 2.2.20

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Next UI Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# @sytechui/use-pagination
+
+A Quick description of the component
+
+> This is an internal utility, not intended for public usage.
+
+## Installation
+
+```sh
+yarn add @sytechui/use-pagination
+# or
+npm i @sytechui/use-pagination
+```
+
+## Contribution
+
+Yes please! See the
+[contributing guidelines](https://github.com/heroui-inc/heroui/blob/master/CONTRIBUTING.md)
+for details.
+
+## License
+
+This project is licensed under the terms of the
+[MIT license](https://github.com/heroui-inc/heroui/blob/master/LICENSE).

package/dist/index.d.mts

@@ -0,0 +1,52 @@
+declare enum PaginationItemType {
+    DOTS = "dots",
+    PREV = "prev",
+    NEXT = "next"
+}
+interface UsePaginationProps {
+    /**
+     * The total number of pages.
+     */
+    total: number;
+    /**
+     * The selected page on initial render.
+     * @default 1
+     */
+    initialPage?: number;
+    /**
+     * The controlled selected page.
+     */
+    page?: number;
+    /**
+     * The number of pages to show on each side of the current page.
+     * @default 1
+     */
+    siblings?: number;
+    /**
+     * The number of pages to show at the beginning and end of the pagination.
+     * @default 1
+     */
+    boundaries?: number;
+    /**
+     * If `true`, the range will include "prev" and "next" buttons.
+     * @default false
+     */
+    showControls?: boolean;
+    /**
+     * Callback fired when the page changes.
+     */
+    onChange?: (page: number) => void;
+}
+type PaginationItemValue = number | PaginationItemType;
+declare function usePagination(props: UsePaginationProps): {
+    range: PaginationItemValue[];
+    activePage: number;
+    setPage: (pageNumber: number) => void;
+    next: () => void;
+    previous: () => void;
+    first: () => void;
+    last: () => void;
+};
+type UsePaginationReturn = ReturnType<typeof usePagination>;
+
+export { PaginationItemType, type PaginationItemValue, type UsePaginationProps, type UsePaginationReturn, usePagination };

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+declare enum PaginationItemType {
+    DOTS = "dots",
+    PREV = "prev",
+    NEXT = "next"
+}
+interface UsePaginationProps {
+    /**
+     * The total number of pages.
+     */
+    total: number;
+    /**
+     * The selected page on initial render.
+     * @default 1
+     */
+    initialPage?: number;
+    /**
+     * The controlled selected page.
+     */
+    page?: number;
+    /**
+     * The number of pages to show on each side of the current page.
+     * @default 1
+     */
+    siblings?: number;
+    /**
+     * The number of pages to show at the beginning and end of the pagination.
+     * @default 1
+     */
+    boundaries?: number;
+    /**
+     * If `true`, the range will include "prev" and "next" buttons.
+     * @default false
+     */
+    showControls?: boolean;
+    /**
+     * Callback fired when the page changes.
+     */
+    onChange?: (page: number) => void;
+}
+type PaginationItemValue = number | PaginationItemType;
+declare function usePagination(props: UsePaginationProps): {
+    range: PaginationItemValue[];
+    activePage: number;
+    setPage: (pageNumber: number) => void;
+    next: () => void;
+    previous: () => void;
+    first: () => void;
+    last: () => void;
+};
+type UsePaginationReturn = ReturnType<typeof usePagination>;
+
+export { PaginationItemType, type PaginationItemValue, type UsePaginationProps, type UsePaginationReturn, usePagination };

package/dist/index.js

@@ -0,0 +1,130 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PaginationItemType: () => PaginationItemType,
+  usePagination: () => usePagination
+});
+module.exports = __toCommonJS(index_exports);
+var import_react = require("react");
+var import_i18n = require("@react-aria/i18n");
+var import_shared_utils = require("@sytechui/shared-utils");
+var PaginationItemType = /* @__PURE__ */ ((PaginationItemType2) => {
+  PaginationItemType2["DOTS"] = "dots";
+  PaginationItemType2["PREV"] = "prev";
+  PaginationItemType2["NEXT"] = "next";
+  return PaginationItemType2;
+})(PaginationItemType || {});
+function usePagination(props) {
+  const {
+    page,
+    total,
+    siblings = 1,
+    boundaries = 1,
+    initialPage = 1,
+    showControls = false,
+    onChange
+  } = props;
+  const [activePage, setActivePage] = (0, import_react.useState)(page || initialPage);
+  const { direction } = (0, import_i18n.useLocale)();
+  const isRTL = direction === "rtl";
+  const onChangeActivePage = (newPage) => {
+    setActivePage(newPage);
+    onChange && onChange(newPage);
+  };
+  (0, import_react.useEffect)(() => {
+    if (page && page !== activePage) {
+      setActivePage(page);
+    }
+  }, [page]);
+  const setPage = (0, import_react.useCallback)(
+    (pageNumber) => {
+      if (pageNumber <= 0) {
+        onChangeActivePage(1);
+      } else if (pageNumber > total) {
+        onChangeActivePage(total);
+      } else {
+        onChangeActivePage(pageNumber);
+      }
+    },
+    [total, activePage, onChangeActivePage]
+  );
+  const next = () => setPage(activePage + 1);
+  const previous = () => setPage(activePage - 1);
+  const first = () => setPage(1);
+  const last = () => setPage(total);
+  const formatRange = (0, import_react.useCallback)(
+    (range2) => {
+      if (showControls) {
+        return ["prev" /* PREV */, ...range2, "next" /* NEXT */];
+      }
+      return range2;
+    },
+    [isRTL, showControls]
+  );
+  const paginationRange = (0, import_react.useMemo)(() => {
+    const totalPageNumbers = siblings * 2 + 3 + boundaries * 2;
+    if (totalPageNumbers >= total) {
+      return formatRange((0, import_shared_utils.range)(1, total));
+    }
+    const leftSiblingIndex = Math.max(activePage - siblings, boundaries);
+    const rightSiblingIndex = Math.min(activePage + siblings, total - boundaries);
+    const shouldShowLeftDots = leftSiblingIndex > boundaries + 2;
+    const shouldShowRightDots = rightSiblingIndex < total - (boundaries + 1);
+    if (!shouldShowLeftDots && shouldShowRightDots) {
+      const leftItemCount = siblings * 2 + boundaries + 2;
+      return formatRange([
+        ...(0, import_shared_utils.range)(1, leftItemCount),
+        "dots" /* DOTS */,
+        ...(0, import_shared_utils.range)(total - (boundaries - 1), total)
+      ]);
+    }
+    if (shouldShowLeftDots && !shouldShowRightDots) {
+      const rightItemCount = boundaries + 1 + 2 * siblings;
+      return formatRange([
+        ...(0, import_shared_utils.range)(1, boundaries),
+        "dots" /* DOTS */,
+        ...(0, import_shared_utils.range)(total - rightItemCount, total)
+      ]);
+    }
+    return formatRange([
+      ...(0, import_shared_utils.range)(1, boundaries),
+      "dots" /* DOTS */,
+      ...(0, import_shared_utils.range)(leftSiblingIndex, rightSiblingIndex),
+      "dots" /* DOTS */,
+      ...(0, import_shared_utils.range)(total - boundaries + 1, total)
+    ]);
+  }, [total, activePage, siblings, boundaries, formatRange]);
+  return {
+    range: paginationRange,
+    activePage,
+    setPage,
+    next,
+    previous,
+    first,
+    last
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PaginationItemType,
+  usePagination
+});

package/dist/index.mjs

@@ -0,0 +1,104 @@
+// src/index.ts
+import { useMemo, useCallback, useState, useEffect } from "react";
+import { useLocale } from "@react-aria/i18n";
+import { range } from "@sytechui/shared-utils";
+var PaginationItemType = /* @__PURE__ */ ((PaginationItemType2) => {
+  PaginationItemType2["DOTS"] = "dots";
+  PaginationItemType2["PREV"] = "prev";
+  PaginationItemType2["NEXT"] = "next";
+  return PaginationItemType2;
+})(PaginationItemType || {});
+function usePagination(props) {
+  const {
+    page,
+    total,
+    siblings = 1,
+    boundaries = 1,
+    initialPage = 1,
+    showControls = false,
+    onChange
+  } = props;
+  const [activePage, setActivePage] = useState(page || initialPage);
+  const { direction } = useLocale();
+  const isRTL = direction === "rtl";
+  const onChangeActivePage = (newPage) => {
+    setActivePage(newPage);
+    onChange && onChange(newPage);
+  };
+  useEffect(() => {
+    if (page && page !== activePage) {
+      setActivePage(page);
+    }
+  }, [page]);
+  const setPage = useCallback(
+    (pageNumber) => {
+      if (pageNumber <= 0) {
+        onChangeActivePage(1);
+      } else if (pageNumber > total) {
+        onChangeActivePage(total);
+      } else {
+        onChangeActivePage(pageNumber);
+      }
+    },
+    [total, activePage, onChangeActivePage]
+  );
+  const next = () => setPage(activePage + 1);
+  const previous = () => setPage(activePage - 1);
+  const first = () => setPage(1);
+  const last = () => setPage(total);
+  const formatRange = useCallback(
+    (range2) => {
+      if (showControls) {
+        return ["prev" /* PREV */, ...range2, "next" /* NEXT */];
+      }
+      return range2;
+    },
+    [isRTL, showControls]
+  );
+  const paginationRange = useMemo(() => {
+    const totalPageNumbers = siblings * 2 + 3 + boundaries * 2;
+    if (totalPageNumbers >= total) {
+      return formatRange(range(1, total));
+    }
+    const leftSiblingIndex = Math.max(activePage - siblings, boundaries);
+    const rightSiblingIndex = Math.min(activePage + siblings, total - boundaries);
+    const shouldShowLeftDots = leftSiblingIndex > boundaries + 2;
+    const shouldShowRightDots = rightSiblingIndex < total - (boundaries + 1);
+    if (!shouldShowLeftDots && shouldShowRightDots) {
+      const leftItemCount = siblings * 2 + boundaries + 2;
+      return formatRange([
+        ...range(1, leftItemCount),
+        "dots" /* DOTS */,
+        ...range(total - (boundaries - 1), total)
+      ]);
+    }
+    if (shouldShowLeftDots && !shouldShowRightDots) {
+      const rightItemCount = boundaries + 1 + 2 * siblings;
+      return formatRange([
+        ...range(1, boundaries),
+        "dots" /* DOTS */,
+        ...range(total - rightItemCount, total)
+      ]);
+    }
+    return formatRange([
+      ...range(1, boundaries),
+      "dots" /* DOTS */,
+      ...range(leftSiblingIndex, rightSiblingIndex),
+      "dots" /* DOTS */,
+      ...range(total - boundaries + 1, total)
+    ]);
+  }, [total, activePage, siblings, boundaries, formatRange]);
+  return {
+    range: paginationRange,
+    activePage,
+    setPage,
+    next,
+    previous,
+    first,
+    last
+  };
+}
+export {
+  PaginationItemType,
+  usePagination
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@sytechui/use-pagination",
+  "version": "2.2.20",
+  "description": "State management hook for Pagination component, it lets you manage pagination with controlled and uncontrolled state",
+  "keywords": [
+    "use-pagination"
+  ],
+  "author": "HeroUI <support@heroui.com>",
+  "homepage": "https://heroui.com",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/heroui-inc/heroui.git",
+    "directory": "packages/hooks/use-pagination"
+  },
+  "bugs": {
+    "url": "https://github.com/heroui-inc/heroui/issues"
+  },
+  "dependencies": {
+    "@react-aria/i18n": "3.12.16",
+    "@sytechui/shared-utils": "2.1.12"
+  },
+  "peerDependencies": {
+    "react": ">=18 || >=19.0.0-rc.0"
+  },
+  "clean-package": "../../../clean-package.config.json",
+  "tsup": {
+    "clean": true,
+    "target": "es2019",
+    "format": [
+      "cjs",
+      "esm"
+    ]
+  },
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsup src --dts",
+    "dev": "pnpm build:fast --watch",
+    "clean": "rimraf dist .turbo",
+    "typecheck": "tsc --noEmit",
+    "build:fast": "tsup src"
+  }
+}