@bsol-oss/react-datatable5 1.0.61 → 1.0.63

package/dist/types/components/Controls/DensityToggleButton.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export interface DensityToggleButtonProps {
+    icon?: React.ReactElement;
+    text?: string;
+}
+export declare const DensityToggleButton: ({ text, icon, }: DensityToggleButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/EditFilterButton.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+export interface EditFilterButtonProps {
+    text?: string;
+    title?: string;
+    closeText?: string;
+    resetText?: string;
+    icon?: React.ReactElement;
+}
+export declare const EditFilterButton: ({ text, title, closeText, resetText, icon, ...props }: EditFilterButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/EditOrderButton.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export interface EditOrderButtonProps {
+    title?: string;
+    icon?: React.ReactElement;
+    text?: string;
+}
+export declare const EditOrderButton: ({ text, icon, title, }: EditOrderButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/EditSortingButton.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface EditSortingButtonProps {
+    title?: string;
+    icon?: React.ReactElement;
+    text?: string;
+}
+export declare const EditSortingButton: ({ text, icon, title, }: EditSortingButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/EditViewButton.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export interface EditViewButtonProps {
+    text?: string;
+    icon?: React.ReactElement;
+    title?: string;
+}
+export declare const EditViewButton: ({ text, icon, title, }: EditViewButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/PageSizeControl.d.ts

@@ -0,0 +1,4 @@
+export interface PageSizeControlProps {
+    pageSizes?: number[];
+}
+export declare const PageSizeControl: ({ pageSizes, }: PageSizeControlProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/ResetFilteringButton.d.ts

@@ -0,0 +1,4 @@
+export interface ResetFilteringButtonProps {
+    text?: string;
+}
+export declare const ResetFilteringButton: ({ text, }: ResetFilteringButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/ResetSelectionButton.d.ts

@@ -0,0 +1,4 @@
+export interface ResetSelectionButtonProps {
+    text?: string;
+}
+export declare const ResetSelectionButton: ({ text, }: ResetSelectionButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/ResetSortingButton.d.ts

@@ -0,0 +1,4 @@
+export interface ResetSortingButtonProps {
+    text?: string;
+}
+export declare const ResetSortingButton: ({ text, }: ResetSortingButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/RowCountText.d.ts

@@ -0,0 +1 @@
+export declare const RowCountText: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Controls/SelectAllRowsToggle.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+export interface SelectAllRowsToggleProps {
+    selectAllIcon: React.ReactElement;
+    clearAllIcon: React.ReactElement;
+    selectAllText: string;
+    clearAllText: string;
+}
+export declare const SelectAllRowsToggle: ({ selectAllIcon, clearAllIcon, selectAllText, clearAllText, }: SelectAllRowsToggleProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+import { ColumnDef, ColumnFiltersState, FilterFn, RowSelectionState, SortingState, VisibilityState } from "@tanstack/react-table";
+import { RankingInfo } from "@tanstack/match-sorter-utils";
+import { DensityState } from "../Controls/DensityFeature";
+declare module "@tanstack/react-table" {
+    interface FilterFns {
+        fuzzy: FilterFn<unknown>;
+    }
+    interface FilterMeta {
+        itemRank: RankingInfo;
+    }
+}
+export interface DataTableProps<TData> {
+    children?: JSX.Element | JSX.Element[];
+    data: TData[];
+    columns: ColumnDef<TData, any>[];
+    enableRowSelection?: boolean;
+    enableMultiRowSelection?: boolean;
+    enableSubRowSelection?: boolean;
+    onRowSelect?: (rowSelectionState: RowSelectionState, data: TData[]) => void;
+    columnOrder?: string[];
+    columnFilters?: ColumnFiltersState;
+    globalFilter?: string;
+    density?: DensityState;
+    pagination?: {
+        pageIndex: number;
+        pageSize: number;
+    };
+    sorting?: SortingState;
+    rowSelection?: RowSelectionState;
+    columnVisibility?: VisibilityState;
+}
+export declare const DataTable: <TData>({ columns, data, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, onRowSelect, columnOrder: defaultColumnOrder, columnFilters: defaultColumnFilter, density, globalFilter: defaultGlobalFilter, pagination: defaultPagination, sorting: defaultSorting, rowSelection: defaultRowSelection, columnVisibility: defaultColumnVisibility, children, }: DataTableProps<TData>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/DataTableContext.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { Table } from "@tanstack/react-table";
+export interface DataTableContext<TData> {
+    table: Table<TData>;
+    refreshData: () => void;
+    globalFilter: string;
+    setGlobalFilter: (filter: string) => void;
+    loading: boolean;
+}
+export declare const TableContext: import("react").Context<DataTableContext<any>>;

package/dist/types/components/DataTable/DataTableServer.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+import { ColumnDef, ColumnFiltersState, RowSelectionState, SortingState, VisibilityState } from "@tanstack/react-table";
+import { DensityState } from "../Controls/DensityFeature";
+export interface DataTableServerProps<TData> {
+    children: JSX.Element | JSX.Element[];
+    url: string;
+    columns: ColumnDef<TData, any>[];
+    enableRowSelection?: boolean;
+    enableMultiRowSelection?: boolean;
+    enableSubRowSelection?: boolean;
+    onRowSelect?: (rowSelectionState: RowSelectionState, data: TData[]) => void;
+    columnOrder?: string[];
+    columnFilters?: ColumnFiltersState;
+    globalFilter?: string;
+    density?: DensityState;
+    pagination?: {
+        pageIndex: number;
+        pageSize: number;
+    };
+    sorting?: SortingState;
+    rowSelection?: RowSelectionState;
+    loadingComponent?: JSX.Element;
+    columnVisibility?: VisibilityState;
+}
+export interface Result<T> {
+    results: T[];
+}
+export interface DataResponse<T> extends Result<T> {
+    success: boolean;
+    count: number;
+    filterCount: number;
+}
+export declare const DataTableServer: <TData>({ columns, url, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, onRowSelect, columnOrder: defaultColumnOrder, columnFilters: defaultColumnFilter, density, globalFilter: defaultGlobalFilter, pagination: defaultPagination, sorting: defaultSorting, rowSelection: defaultRowSelection, columnVisibility: defaultColumnVisibility, children, }: DataTableServerProps<TData>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/DefaultTable.d.ts

@@ -0,0 +1,5 @@
+import { TableControlsProps } from "./TableControls";
+export interface DefaultTableProps extends TableControlsProps {
+    showFooter?: boolean;
+}
+export declare const DefaultTable: ({ totalText, showFilter, showFooter, fitTableWidth, fitTableHeight, isMobile, filterOptions, showFilterTags, showFilterName, }: DefaultTableProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/Table.d.ts

@@ -0,0 +1,8 @@
+import { TableProps as ChakraTableProps } from "@chakra-ui/react";
+import { ReactNode } from "react";
+export interface TableProps extends ChakraTableProps {
+    showLoading?: boolean;
+    loadingComponent?: JSX.Element;
+    children: ReactNode;
+}
+export declare const Table: ({ children, showLoading, loadingComponent, ...props }: TableProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableBody.d.ts

@@ -0,0 +1,17 @@
+import { Row } from "@tanstack/react-table";
+export interface TableBodyProps {
+    pinnedBgColor?: {
+        light: string;
+        dark: string;
+    };
+}
+export interface TableRowSelectorProps<TData> {
+    index: number;
+    row: Row<TData>;
+    hoveredRow: number;
+    pinnedBgColor?: {
+        light: string;
+        dark: string;
+    };
+}
+export declare const TableBody: ({ pinnedBgColor, }: TableBodyProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableCardContainer.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { GridProps } from "@chakra-ui/react";
+export interface TableCardContainerProps extends GridProps {
+    children: JSX.Element;
+}
+export declare const TableCardContainer: ({ children, ...props }: TableCardContainerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableCards.d.ts

@@ -0,0 +1,4 @@
+export interface TableCardsProps {
+    isSelectable?: boolean;
+}
+export declare const TableCards: ({ isSelectable }: TableCardsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableComponent.d.ts

@@ -0,0 +1,6 @@
+import { Table } from "@tanstack/react-table";
+import React from "react";
+export interface TableRendererProps<TData> {
+    render: (render: Table<TData>) => React.ReactElement;
+}
+export declare const TableComponent: <TData>({ render, }: TableRendererProps<TData>) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;

package/dist/types/components/DataTable/TableControls.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+export interface TableControlsProps {
+    totalText?: string;
+    showFilter?: boolean;
+    fitTableWidth?: boolean;
+    fitTableHeight?: boolean;
+    isMobile?: boolean;
+    children?: JSX.Element;
+    showFilterName?: boolean;
+    showFilterTags?: boolean;
+    filterOptions?: string[];
+}
+export declare const TableControls: ({ totalText, showFilter, fitTableWidth, fitTableHeight, isMobile, children, showFilterName, showFilterTags, filterOptions, }: TableControlsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableFilter.d.ts

@@ -0,0 +1 @@
+export declare const TableFilter: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableFilterTags.d.ts

@@ -0,0 +1 @@
+export declare const TableFilterTags: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableFooter.d.ts

@@ -0,0 +1,7 @@
+export interface TableFooterProps {
+    pinnedBgColor?: {
+        light: string;
+        dark: string;
+    };
+}
+export declare const TableFooter: ({ pinnedBgColor, }: TableFooterProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableHeader.d.ts

@@ -0,0 +1,8 @@
+export interface TableHeaderProps {
+    canResize?: boolean;
+    pinnedBgColor?: {
+        light: string;
+        dark: string;
+    };
+}
+export declare const TableHeader: ({ canResize, pinnedBgColor, }: TableHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableLoadingComponent.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export interface TableLoadingComponentProps {
+    render: (loading: boolean) => JSX.Element;
+}
+export declare const TableLoadingComponent: ({ render, }: TableLoadingComponentProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableOrderer.d.ts

@@ -0,0 +1 @@
+export declare const TableOrderer: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TablePagination.d.ts

@@ -0,0 +1,3 @@
+export interface PaginationProps {
+}
+export declare const TablePagination: ({}: PaginationProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableReloadButton.d.ts

@@ -0,0 +1,4 @@
+export interface ReloadButtonProps {
+    text?: string;
+}
+export declare const ReloadButton: ({ text }: ReloadButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableSelector.d.ts

@@ -0,0 +1 @@
+export declare const TableSelector: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableSorter.d.ts

@@ -0,0 +1 @@
+export declare const TableSorter: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TableViewer.d.ts

@@ -0,0 +1 @@
+export declare const TableViewer: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/TextCell.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { TextProps, TooltipProps } from "@chakra-ui/react";
+export interface TextCellProps extends TextProps {
+    label?: string;
+    noOfLines?: number[];
+    padding?: string;
+    children: string | number | JSX.Element | JSX.Element[];
+    tooltipProps?: TooltipProps;
+}
+export declare const TextCell: ({ label, noOfLines, padding, children, tooltipProps, ...props }: TextCellProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/DataTable/useDataFromUrl.d.ts

@@ -0,0 +1,14 @@
+export interface useDataFromUrlReturn<T> {
+    data: T;
+    loading: boolean;
+    hasError: boolean;
+    refreshData: () => void;
+}
+export interface useDataFromUrlProps<T> {
+    url: string;
+    params?: object;
+    defaultData: T;
+    disableFirstFetch?: boolean;
+    onFetchSuccess?: (data: T) => void;
+}
+export declare const useDataFromUrl: <T>({ url, params, disableFirstFetch, onFetchSuccess, defaultData, }: useDataFromUrlProps<T>) => useDataFromUrlReturn<T>;

package/dist/types/components/DataTable/useDataTable.d.ts

@@ -0,0 +1,7 @@
+export declare const useDataTable: () => {
+    table: import("@tanstack/table-core").Table<any>;
+    refreshData: () => void;
+    globalFilter: string;
+    setGlobalFilter: (filter: string) => void;
+    loading: boolean;
+};

package/dist/types/components/Filter/DateRangeFilter.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+interface DateRangeFilterProps {
+    startDate: string;
+    endDate: string;
+    setStartDate: (value: string) => void;
+    setEndDate: (value: string) => void;
+}
+export declare const DateRangeFilter: React.FC<DateRangeFilterProps>;
+export {};

package/dist/types/components/Filter/FilterOptions.d.ts

@@ -0,0 +1,4 @@
+export interface FilterOptionsProps {
+    column: string;
+}
+export declare const FilterOptions: ({ column }: FilterOptionsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Filter/GlobalFilter.d.ts

@@ -0,0 +1,3 @@
+export declare const GlobalFilter: ({ icon }: {
+    icon?: import("react-icons/lib").IconType | undefined;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Filter/RangeFilter.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+interface RangeFilterProps {
+    range: [number, number];
+    setRange: (value: [number, number]) => void;
+    defaultValue: [number, number];
+    min: number;
+    max: number;
+    step: number;
+}
+declare const RangeFilter: React.FC<RangeFilterProps>;
+export default RangeFilter;

package/dist/types/components/Filter/TagFilter.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface TagFilterProps {
+    availableTags: string[];
+    selectedTags: string[];
+    onTagChange: (tags: string[]) => void;
+}
+export declare const TagFilter: React.FC<TagFilterProps>;
+export {};

package/dist/types/index.d.ts

@@ -1,35 +1,54 @@
-export * from "./components/DataTable";
-export * from "./components/DataTableServer";
-export * from "./components/DefaultTable";
-export * from "./components/DensityToggleButton";
-export * from "./components/EditFilterButton";
-export * from "./components/EditOrderButton";
-export * from "./components/EditSortingButton";
-export * from "./components/EditViewButton";
-export * from "./components/FilterOptions";
-export * from "./components/GlobalFilter";
-export * from "./components/PageSizeControl";
-export * from "./components/ResetFilteringButton";
-export * from "./components/ResetSelectionButton";
-export * from "./components/ResetSortingButton";
-export * from "./components/RowCountText";
-export * from "./components/Table";
-export * from "./components/TableBody";
-export * from "./components/TableCardContainer";
-export * from "./components/TableCards";
-export * from "./components/TableComponent";
-export * from "./components/TableControls";
-export * from "./components/TableFilter";
-export * from "./components/TableFilterTags";
-export * from "./components/TableFooter";
-export * from "./components/TableHeader";
-export * from "./components/TableLoadingComponent";
-export * from "./components/TableOrderer";
-export * from "./components/TablePagination";
-export * from "./components/TableReloadButton";
-export * from "./components/TableSelector";
-export * from "./components/TableSorter";
-export * from "./components/TableViewer";
-export * from "./components/TextCell";
-export * from "./components/useDataFromUrl";
-export * from "./components/useDataTable";
+/// <reference types="react" />
+import { Column, RowData } from "@tanstack/react-table";
+declare module "@tanstack/react-table" {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        displayName?: string;
+        /**
+         * @note you should provide a proper `filterfn` to handle the filtering when choosing `boolean`, `dateRange` and `custom`
+         */
+        filterVariant?: "text" | "range" | "select" | "tag" | "boolean" | "dateRange" | "custom";
+        filterOptions?: string[];
+        filterRangeConfig?: {
+            min: number;
+            max: number;
+            step: number;
+            defaultValue: [number, number];
+        };
+        renderFilter?: (column: Column<TData>) => JSX.Element;
+    }
+}
+export * from "./components/DataTable/DataTable";
+export * from "./components/DataTable/DataTableServer";
+export * from "./components/DataTable/DefaultTable";
+export * from "./components/Controls/DensityToggleButton";
+export * from "./components/Controls/EditFilterButton";
+export * from "./components/Controls/EditOrderButton";
+export * from "./components/Controls/EditSortingButton";
+export * from "./components/Controls/EditViewButton";
+export * from "./components/Filter/FilterOptions";
+export * from "./components/Filter/GlobalFilter";
+export * from "./components/Controls/PageSizeControl";
+export * from "./components/Controls/ResetFilteringButton";
+export * from "./components/Controls/ResetSelectionButton";
+export * from "./components/Controls/ResetSortingButton";
+export * from "./components/Controls/RowCountText";
+export * from "./components/DataTable/Table";
+export * from "./components/DataTable/TableBody";
+export * from "./components/DataTable/TableCardContainer";
+export * from "./components/DataTable/TableCards";
+export * from "./components/DataTable/TableComponent";
+export * from "./components/DataTable/TableControls";
+export * from "./components/DataTable/TableFilter";
+export * from "./components/DataTable/TableFilterTags";
+export * from "./components/DataTable/TableFooter";
+export * from "./components/DataTable/TableHeader";
+export * from "./components/DataTable/TableLoadingComponent";
+export * from "./components/DataTable/TableOrderer";
+export * from "./components/DataTable/TablePagination";
+export * from "./components/DataTable/TableReloadButton";
+export * from "./components/DataTable/TableSelector";
+export * from "./components/DataTable/TableSorter";
+export * from "./components/DataTable/TableViewer";
+export * from "./components/DataTable/TextCell";
+export * from "./components/DataTable/useDataFromUrl";
+export * from "./components/DataTable/useDataTable";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsol-oss/react-datatable5",
-  "version": "1.0.61",
+  "version": "1.0.63",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.mjs",