@up42/up-components 3.0.3 → 3.1.0

package/dist/esm/types/index.d.ts

@@ -54,5 +54,6 @@ export { formatDate } from './utils/helpers/formatDate';
 export { formatFileSize } from './utils/helpers/formatFileSize';
 export { useQueryParams } from './utils/hooks/useQueryParams';
 export { useRemotePagination, type PaginatedResponse } from './utils/hooks/useRemotePagination';
+export { useCursorPagination, type CursorPaginatedResponse } from './utils/hooks/useCursorPagination';
 export { useDebounce } from './utils/hooks/useDebounce';
 export { useAlert, type CreateAlertProps, type CreateSnackbarProps, } from './global/providers/AlertProvider/AlertProvider';

package/dist/esm/types/utils/hooks/useCursorPagination.d.ts

@@ -0,0 +1,34 @@
+export interface CursorPaginatedResponse<T> {
+    content: T[];
+    nextCursor: number | null;
+    prevCursor: number | null;
+}
+type UseCursorPaginationResponse = {
+    pageSize: number;
+    page: number;
+    data: any[];
+    isLoading: boolean;
+    refetch: () => Promise<any>;
+    isRefetching: boolean;
+    setPage: (page: number) => void;
+    setPageSize: (pageSize: number) => void;
+    handlePageChange: (page: number, pageSize: number) => void;
+    cursor: number;
+    setCursor: (cursor: number) => void;
+};
+/**
+ * Returns cursor-based pagination data and and helper functions.
+ *
+ * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#usecursorpagination
+ */
+export declare const useCursorPagination: (fetchingHook: ({ params }: {
+    params: string;
+}) => {
+    data: CursorPaginatedResponse<any> | undefined;
+    isLoading: boolean;
+    refetch: () => Promise<any>;
+    isRefetching: boolean;
+}, searchParams?: {
+    [paramName: string]: string;
+} | undefined) => UseCursorPaginationResponse;
+export {};

package/dist/esm/types/utils/hooks/useCursorPagination.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -5023,6 +5023,40 @@ declare const useRemotePagination: (fetchingHook: ({ params }: {
     [paramName: string]: string;
 } | undefined) => UseRemotePaginationResponse;
 
+interface CursorPaginatedResponse<T> {
+    content: T[];
+    nextCursor: number | null;
+    prevCursor: number | null;
+}
+type UseCursorPaginationResponse = {
+    pageSize: number;
+    page: number;
+    data: any[];
+    isLoading: boolean;
+    refetch: () => Promise<any>;
+    isRefetching: boolean;
+    setPage: (page: number) => void;
+    setPageSize: (pageSize: number) => void;
+    handlePageChange: (page: number, pageSize: number) => void;
+    cursor: number;
+    setCursor: (cursor: number) => void;
+};
+/**
+ * Returns cursor-based pagination data and and helper functions.
+ *
+ * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#usecursorpagination
+ */
+declare const useCursorPagination: (fetchingHook: ({ params }: {
+    params: string;
+}) => {
+    data: CursorPaginatedResponse<any> | undefined;
+    isLoading: boolean;
+    refetch: () => Promise<any>;
+    isRefetching: boolean;
+}, searchParams?: {
+    [paramName: string]: string;
+} | undefined) => UseCursorPaginationResponse;
+
 /**
  * useDebounce is a generic React Hook that returns a debounced version of a given value.
  * @param {T} value - The value to debounce.
@@ -5084,4 +5118,4 @@ type ContextState = {
  */
 declare const useAlert: () => ContextState;
 
-export { Alert, type AlertProps, Avatar, type AvatarProps, Badge, type BadgeProps, Banner, type BannerProps, Button, type ButtonProps, Checkbox, type CheckboxProps, CodeInline, type CodeInlineProps, CodeSnippet, type CodeSnippetItemProps, type CodeSnippetProps, ContactBox, type ContactBoxProps, ControlButton, type ControlButtonProps, CopyButton, type CopyButtonProps, type CreateAlertProps, type CreateSnackbarProps, DataGrid, type DataGridProps, type DatePickerDateType, DateTime, type DateTimeProps, Divider, type DividerProps, DocumentationPopover, type DocumentationPopoverProps, EmptyState, type EmptyStateProps, FormCheckbox, type FormCheckboxProps, FormDatePicker, type FormDatePickerProps, FormDateRangePicker, type FormDateRangePickerProps, FormInput, type FormInputProps, FormRadio, type FormRadioProps, FormSelect, type FormSelectProps, FormSwitch, type FormSwitchProps, GridContainer, type GridContainerProps, GridItem, type GridItemProps, Icon, type IconProps, Illustration, type IllustrationProps, InfoCard, type InfoCardProps, InfoModal, type InfoModalProps, InfoPopover, type InfoPopoverProps, Input, type InputProps, Link, type LinkProps, Loading, type LoadingProps, NotFound, type NotFoundProps, PageContainer, type PageContainerProps, PageHeader, type PageHeaderProps, type PaginatedResponse, Radio, type RadioProps, Select, type SelectProps, Slider, type SliderProps, Switch, type SwitchProps, Tab, TabGroup, type TabGroupProps, type TabProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableContainer, type TableContainerProps, TableFooter, type TableFooterProps, TableHead, type TableHeadProps, TablePagination, type TablePaginationProps, type TableProps, TableRow, type TableRowProps, TableSortLabel, type TableSortLabelProps, Tabs, type TabsProps, Tag, type TagProps, Typography, type TypographyProps, UpComponentsProvider, capitalize, copyToClipboard, formatDate, formatFileSize, formatNumber, theme, useAlert, useDebounce, useQueryParams, useRemotePagination };
+export { Alert, type AlertProps, Avatar, type AvatarProps, Badge, type BadgeProps, Banner, type BannerProps, Button, type ButtonProps, Checkbox, type CheckboxProps, CodeInline, type CodeInlineProps, CodeSnippet, type CodeSnippetItemProps, type CodeSnippetProps, ContactBox, type ContactBoxProps, ControlButton, type ControlButtonProps, CopyButton, type CopyButtonProps, type CreateAlertProps, type CreateSnackbarProps, type CursorPaginatedResponse, DataGrid, type DataGridProps, type DatePickerDateType, DateTime, type DateTimeProps, Divider, type DividerProps, DocumentationPopover, type DocumentationPopoverProps, EmptyState, type EmptyStateProps, FormCheckbox, type FormCheckboxProps, FormDatePicker, type FormDatePickerProps, FormDateRangePicker, type FormDateRangePickerProps, FormInput, type FormInputProps, FormRadio, type FormRadioProps, FormSelect, type FormSelectProps, FormSwitch, type FormSwitchProps, GridContainer, type GridContainerProps, GridItem, type GridItemProps, Icon, type IconProps, Illustration, type IllustrationProps, InfoCard, type InfoCardProps, InfoModal, type InfoModalProps, InfoPopover, type InfoPopoverProps, Input, type InputProps, Link, type LinkProps, Loading, type LoadingProps, NotFound, type NotFoundProps, PageContainer, type PageContainerProps, PageHeader, type PageHeaderProps, type PaginatedResponse, Radio, type RadioProps, Select, type SelectProps, Slider, type SliderProps, Switch, type SwitchProps, Tab, TabGroup, type TabGroupProps, type TabProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableContainer, type TableContainerProps, TableFooter, type TableFooterProps, TableHead, type TableHeadProps, TablePagination, type TablePaginationProps, type TableProps, TableRow, type TableRowProps, TableSortLabel, type TableSortLabelProps, Tabs, type TabsProps, Tag, type TagProps, Typography, type TypographyProps, UpComponentsProvider, capitalize, copyToClipboard, formatDate, formatFileSize, formatNumber, theme, useAlert, useCursorPagination, useDebounce, useQueryParams, useRemotePagination };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@up42/up-components",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "UP42 Component Library",
   "author": "Axel Fuhrmann axel.fuhrmann@up42.com",
   "license": "ISC",