@allxsmith/bestax-bulma 5.17.0 → 5.18.0

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

@@ -24,12 +24,45 @@ export interface PaginationProps extends React.HTMLAttributes<HTMLElement>, Omit
     align?: 'centered' | 'right';
     /** Renders pagination with rounded corners. */
     rounded?: boolean;
-    /** Total number of pages (for custom implementations). */
+    /**
+     * The number of pages. Given `total` and no children, `Pagination` renders
+     * the whole control itself: Previous, Next and a link for each page it
+     * shows, with an ellipsis where it skips some. Given children, it renders
+     * those as they are, and `total` and the other page props do nothing.
+     */
     total?: number;
-    /** Current page (for controlled implementations). */
+    /**
+     * The page shown as current, counting from 1, when rendering from `total`.
+     * Leave it out and `Pagination` keeps the page itself, starting at 1.
+     */
     current?: number;
-    /** Callback when a page is selected. */
+    /**
+     * Called with the page chosen, when rendering from `total`. Choosing the
+     * page already current doesn't call it.
+     */
     onPageChange?: (page: number) => void;
+    /** How many pages to show on each side of the current one, when rendering from `total`. */
+    siblingCount?: number;
+    /** How many pages to always show at the start and at the end, when rendering from `total`. */
+    boundaryCount?: number;
+    /** The Previous link's content, when rendering from `total`. */
+    previousLabel?: React.ReactNode;
+    /** The Next link's content, when rendering from `total`. */
+    nextLabel?: React.ReactNode;
+    /** Disables every link, when rendering from `total`. */
+    disabled?: boolean;
+    /**
+     * The `href` for a page's link, when rendering from `total`, making each
+     * one a real link (`page => '?page=' + page`). A click then calls
+     * `onPageChange` and the browser follows the link too. Without it the
+     * links have no `href`, act as buttons, and Enter or Space chooses a page.
+     */
+    getPageHref?: (page: number) => string;
+    /**
+     * The accessible name of a page's link, when rendering from `total`, since
+     * its content is only the number (`page => 'Page ' + page` by default).
+     */
+    getPageLabel?: (page: number) => string;
     /** Additional CSS classes. */
     className?: string;
     /** Custom pagination content (usually subcomponents). */

package/dist/types-cjs/components/Pagination.d.ts

@@ -24,12 +24,45 @@ export interface PaginationProps extends React.HTMLAttributes<HTMLElement>, Omit
     align?: 'centered' | 'right';
     /** Renders pagination with rounded corners. */
     rounded?: boolean;
-    /** Total number of pages (for custom implementations). */
+    /**
+     * The number of pages. Given `total` and no children, `Pagination` renders
+     * the whole control itself: Previous, Next and a link for each page it
+     * shows, with an ellipsis where it skips some. Given children, it renders
+     * those as they are, and `total` and the other page props do nothing.
+     */
     total?: number;
-    /** Current page (for controlled implementations). */
+    /**
+     * The page shown as current, counting from 1, when rendering from `total`.
+     * Leave it out and `Pagination` keeps the page itself, starting at 1.
+     */
     current?: number;
-    /** Callback when a page is selected. */
+    /**
+     * Called with the page chosen, when rendering from `total`. Choosing the
+     * page already current doesn't call it.
+     */
     onPageChange?: (page: number) => void;
+    /** How many pages to show on each side of the current one, when rendering from `total`. */
+    siblingCount?: number;
+    /** How many pages to always show at the start and at the end, when rendering from `total`. */
+    boundaryCount?: number;
+    /** The Previous link's content, when rendering from `total`. */
+    previousLabel?: React.ReactNode;
+    /** The Next link's content, when rendering from `total`. */
+    nextLabel?: React.ReactNode;
+    /** Disables every link, when rendering from `total`. */
+    disabled?: boolean;
+    /**
+     * The `href` for a page's link, when rendering from `total`, making each
+     * one a real link (`page => '?page=' + page`). A click then calls
+     * `onPageChange` and the browser follows the link too. Without it the
+     * links have no `href`, act as buttons, and Enter or Space chooses a page.
+     */
+    getPageHref?: (page: number) => string;
+    /**
+     * The accessible name of a page's link, when rendering from `total`, since
+     * its content is only the number (`page => 'Page ' + page` by default).
+     */
+    getPageLabel?: (page: number) => string;
     /** Additional CSS classes. */
     className?: string;
     /** Custom pagination content (usually subcomponents). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allxsmith/bestax-bulma",
-  "version": "5.17.0",
+  "version": "5.18.0",
   "description": "A fully-typed React component library for the Bulma CSS framework. Build modern UIs quickly with reusable, accessible, and customizable Bulma-based React components.",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",