@bsol-oss/react-datatable5 9.2.0 → 11.0.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +189 -40
- package/dist/index.d.ts +19 -18
- package/dist/index.js +42 -38
- package/dist/index.mjs +47 -43
- package/dist/types/components/Controls/FilterDialog.d.ts +5 -0
- package/dist/types/components/Controls/Pagination.d.ts +1 -0
- package/dist/types/components/Controls/ViewDialog.d.ts +5 -0
- package/dist/types/components/DataTable/DataTable.d.ts +3 -1
- package/dist/types/components/DataTable/DataTableServer.d.ts +3 -1
- package/dist/types/components/DataTable/TableControls.d.ts +2 -2
- package/dist/types/components/DataTable/context/DataTableContext.d.ts +2 -0
- package/dist/types/components/DataTable/useDataTable.d.ts +4 -1
- package/dist/types/components/DataTable/useDataTableServer.d.ts +1 -1
- package/dist/types/components/Form/Form.d.ts +4 -2
- package/dist/types/components/Form/SchemaFormContext.d.ts +3 -0
- package/dist/types/components/Form/useSchemaContext.d.ts +2 -0
- package/dist/types/index.d.ts +3 -3
- package/package.json +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const Pagination: () => import("react/jsx-runtime").JSX.Element;
|
|
@@ -2,6 +2,7 @@ import { ColumnDef, ColumnFiltersState, ColumnOrderState, FilterFn, OnChangeFn,
|
|
|
2
2
|
import { ReactNode } from "react";
|
|
3
3
|
import { RankingInfo } from "@tanstack/match-sorter-utils";
|
|
4
4
|
import { DensityState } from "../Controls/DensityFeature";
|
|
5
|
+
import { UseTranslationResponse } from "react-i18next";
|
|
5
6
|
declare module "@tanstack/react-table" {
|
|
6
7
|
interface FilterFns {
|
|
7
8
|
fuzzy: FilterFn<unknown>;
|
|
@@ -47,6 +48,7 @@ export interface DataTableProps<TData = unknown> {
|
|
|
47
48
|
setColumnOrder: OnChangeFn<ColumnOrderState>;
|
|
48
49
|
setDensity: OnChangeFn<DensityState>;
|
|
49
50
|
setColumnVisibility: OnChangeFn<VisibilityState>;
|
|
51
|
+
translate: UseTranslationResponse<any, any>;
|
|
50
52
|
}
|
|
51
53
|
/**
|
|
52
54
|
* DataTable will create a context to hold all values to
|
|
@@ -58,4 +60,4 @@ export interface DataTableProps<TData = unknown> {
|
|
|
58
60
|
*
|
|
59
61
|
* @link https://tanstack.com/table/latest/docs/guide/column-defs
|
|
60
62
|
*/
|
|
61
|
-
export declare function DataTable<TData = unknown>({ columns, data, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, columnOrder, columnFilters, columnVisibility, density, globalFilter, pagination, sorting, rowSelection, setPagination, setSorting, setColumnFilters, setRowSelection, setGlobalFilter, setColumnOrder, setDensity, setColumnVisibility, children, }: DataTableProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
63
|
+
export declare function DataTable<TData = unknown>({ columns, data, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, columnOrder, columnFilters, columnVisibility, density, globalFilter, pagination, sorting, rowSelection, setPagination, setSorting, setColumnFilters, setRowSelection, setGlobalFilter, setColumnOrder, setDensity, setColumnVisibility, translate, children, }: DataTableProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
@@ -3,6 +3,7 @@ import { UseQueryResult } from "@tanstack/react-query";
|
|
|
3
3
|
import { ColumnDef, ColumnFiltersState, ColumnOrderState, OnChangeFn, PaginationState, RowSelectionState, SortingState, VisibilityState } from "@tanstack/react-table";
|
|
4
4
|
import { DensityState } from "../Controls/DensityFeature";
|
|
5
5
|
import { DataResponse } from "./useDataTableServer";
|
|
6
|
+
import { UseTranslationResponse } from "react-i18next";
|
|
6
7
|
export interface DataTableServerProps<TData extends DataResponse = DataResponse<unknown>> {
|
|
7
8
|
children: ReactNode | ReactNode[];
|
|
8
9
|
/**
|
|
@@ -34,6 +35,7 @@ export interface DataTableServerProps<TData extends DataResponse = DataResponse<
|
|
|
34
35
|
setColumnVisibility: OnChangeFn<VisibilityState>;
|
|
35
36
|
query: UseQueryResult<TData>;
|
|
36
37
|
url: string;
|
|
38
|
+
translate: UseTranslationResponse<any, any>;
|
|
37
39
|
}
|
|
38
40
|
/**
|
|
39
41
|
* DataTableServer will create a context to hold all values to
|
|
@@ -46,4 +48,4 @@ export interface DataTableServerProps<TData extends DataResponse = DataResponse<
|
|
|
46
48
|
*
|
|
47
49
|
* @link https://tanstack.com/table/latest/docs/guide/column-defs
|
|
48
50
|
*/
|
|
49
|
-
export declare function DataTableServer<TData extends DataResponse = DataResponse<unknown>>({ columns, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, columnOrder, columnFilters, columnVisibility, density, globalFilter, pagination, sorting, rowSelection, setPagination, setSorting, setColumnFilters, setRowSelection, setGlobalFilter, setColumnOrder, setDensity, setColumnVisibility, query,
|
|
51
|
+
export declare function DataTableServer<TData extends DataResponse = DataResponse<unknown>>({ columns, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, columnOrder, columnFilters, columnVisibility, density, globalFilter, pagination, sorting, rowSelection, setPagination, setSorting, setColumnFilters, setRowSelection, setGlobalFilter, setColumnOrder, setDensity, setColumnVisibility, query, url, translate, children, }: DataTableServerProps<TData>): import("react/jsx-runtime").JSX.Element;
|
|
@@ -3,7 +3,6 @@ export interface TableControlsProps {
|
|
|
3
3
|
totalText?: string;
|
|
4
4
|
fitTableWidth?: boolean;
|
|
5
5
|
fitTableHeight?: boolean;
|
|
6
|
-
isMobile?: boolean;
|
|
7
6
|
children?: ReactNode;
|
|
8
7
|
showGlobalFilter?: boolean;
|
|
9
8
|
showFilter?: boolean;
|
|
@@ -13,9 +12,10 @@ export interface TableControlsProps {
|
|
|
13
12
|
showPagination?: boolean;
|
|
14
13
|
showPageSizeControl?: boolean;
|
|
15
14
|
showPageCountText?: boolean;
|
|
15
|
+
showView?: boolean;
|
|
16
16
|
filterOptions?: string[];
|
|
17
17
|
extraItems?: ReactNode;
|
|
18
18
|
loading?: boolean;
|
|
19
19
|
hasError?: boolean;
|
|
20
20
|
}
|
|
21
|
-
export declare const TableControls: ({
|
|
21
|
+
export declare const TableControls: ({ fitTableWidth, fitTableHeight, children, showGlobalFilter, showFilter, showFilterName, showFilterTags, showReload, showPagination, showPageSizeControl, showPageCountText, showView, filterOptions, extraItems, loading, hasError, }: TableControlsProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { OnChangeFn, Table } from "@tanstack/react-table";
|
|
3
|
+
import { UseTranslationResponse } from "react-i18next";
|
|
3
4
|
export interface DataTableContext<TData = unknown> {
|
|
4
5
|
table: Table<TData>;
|
|
5
6
|
globalFilter: string;
|
|
6
7
|
setGlobalFilter: OnChangeFn<string>;
|
|
7
8
|
type: "client" | "server";
|
|
9
|
+
translate: UseTranslationResponse<any, any>;
|
|
8
10
|
}
|
|
9
11
|
export declare const DataTableContext: import("react").Context<DataTableContext<unknown>>;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ColumnFiltersState, ColumnOrderState, OnChangeFn, PaginationState, RowSelectionState, SortingState, VisibilityState } from "@tanstack/react-table";
|
|
2
2
|
import { DensityState } from "../Controls/DensityFeature";
|
|
3
|
+
import { UseTranslationResponse } from "react-i18next";
|
|
3
4
|
export interface DataTableDefaultState {
|
|
4
5
|
sorting?: SortingState;
|
|
5
6
|
columnFilters?: ColumnFiltersState;
|
|
@@ -12,6 +13,7 @@ export interface DataTableDefaultState {
|
|
|
12
13
|
}
|
|
13
14
|
export interface UseDataTableProps {
|
|
14
15
|
default?: DataTableDefaultState;
|
|
16
|
+
keyPrefix?: string;
|
|
15
17
|
}
|
|
16
18
|
export interface UseDataTableReturn {
|
|
17
19
|
sorting: SortingState;
|
|
@@ -30,5 +32,6 @@ export interface UseDataTableReturn {
|
|
|
30
32
|
setColumnOrder: OnChangeFn<ColumnOrderState>;
|
|
31
33
|
setDensity: OnChangeFn<DensityState>;
|
|
32
34
|
setColumnVisibility: OnChangeFn<VisibilityState>;
|
|
35
|
+
translate: UseTranslationResponse<any, any>;
|
|
33
36
|
}
|
|
34
|
-
export declare const useDataTable: ({ default: { sorting: defaultSorting, pagination: defaultPagination, rowSelection: defaultRowSelection, columnFilters: defaultColumnFilters, columnOrder: defaultColumnOrder, columnVisibility: defaultColumnVisibility, globalFilter: defaultGlobalFilter, density: defaultDensity, }, }?: UseDataTableProps) => UseDataTableReturn;
|
|
37
|
+
export declare const useDataTable: ({ default: { sorting: defaultSorting, pagination: defaultPagination, rowSelection: defaultRowSelection, columnFilters: defaultColumnFilters, columnOrder: defaultColumnOrder, columnVisibility: defaultColumnVisibility, globalFilter: defaultGlobalFilter, density: defaultDensity, }, keyPrefix, }?: UseDataTableProps) => UseDataTableReturn;
|
|
@@ -24,4 +24,4 @@ export interface Result<T = unknown> {
|
|
|
24
24
|
export interface DataResponse<T = unknown> extends Result<T> {
|
|
25
25
|
count: number;
|
|
26
26
|
}
|
|
27
|
-
export declare const useDataTableServer: <TData>({ url, default: { sorting: defaultSorting, pagination: defaultPagination, rowSelection: defaultRowSelection, columnFilters: defaultColumnFilters, columnOrder: defaultColumnOrder, columnVisibility: defaultColumnVisibility, globalFilter: defaultGlobalFilter, density: defaultDensity, }, }: UseDataTableServerProps) => UseDataTableServerReturn<TData>;
|
|
27
|
+
export declare const useDataTableServer: <TData>({ url, default: { sorting: defaultSorting, pagination: defaultPagination, rowSelection: defaultRowSelection, columnFilters: defaultColumnFilters, columnOrder: defaultColumnOrder, columnVisibility: defaultColumnVisibility, globalFilter: defaultGlobalFilter, density: defaultDensity, }, keyPrefix, }: UseDataTableServerProps) => UseDataTableServerReturn<TData>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ForeignKeyProps } from "@/components/Form/components/StringInputField";
|
|
2
|
+
import { AxiosRequestConfig } from "axios";
|
|
2
3
|
import { JSONSchema7 } from "json-schema";
|
|
3
4
|
import { Dispatch, SetStateAction } from "react";
|
|
4
5
|
import { FieldValues, SubmitHandler, UseFormReturn } from "react-hook-form";
|
|
@@ -6,6 +7,7 @@ import { UseTranslationResponse } from "react-i18next";
|
|
|
6
7
|
export interface FormProps<TData extends FieldValues> {
|
|
7
8
|
schema: JSONSchema7;
|
|
8
9
|
serverUrl: string;
|
|
10
|
+
requestUrl?: string;
|
|
9
11
|
idMap: Record<string, object>;
|
|
10
12
|
setIdMap: Dispatch<SetStateAction<Record<string, object>>>;
|
|
11
13
|
form: UseFormReturn;
|
|
@@ -13,8 +15,8 @@ export interface FormProps<TData extends FieldValues> {
|
|
|
13
15
|
order?: string[];
|
|
14
16
|
ignore?: string[];
|
|
15
17
|
onSubmit?: SubmitHandler<TData>;
|
|
16
|
-
preLoadedValues?: object;
|
|
17
18
|
rowNumber?: number | string;
|
|
19
|
+
requestOptions?: AxiosRequestConfig;
|
|
18
20
|
}
|
|
19
21
|
export interface CustomJSONSchema7Definition extends JSONSchema7 {
|
|
20
22
|
variant: string;
|
|
@@ -25,4 +27,4 @@ export interface CustomJSONSchema7Definition extends JSONSchema7 {
|
|
|
25
27
|
gridRow: string;
|
|
26
28
|
foreign_key: ForeignKeyProps;
|
|
27
29
|
}
|
|
28
|
-
export declare const Form: <TData extends FieldValues>({ schema, idMap, setIdMap, form, serverUrl, translate, order, ignore, onSubmit, preLoadedValues, rowNumber, }: FormProps<TData>) => import("react/jsx-runtime").JSX.Element;
|
|
30
|
+
export declare const Form: <TData extends FieldValues>({ schema, idMap, setIdMap, form, serverUrl, translate, order, ignore, onSubmit, preLoadedValues, rowNumber, requestOptions, }: FormProps<TData>) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { AxiosRequestConfig } from "axios";
|
|
1
2
|
import { JSONSchema7 } from "json-schema";
|
|
2
3
|
import { Dispatch, SetStateAction } from "react";
|
|
3
4
|
import { FieldValues } from "react-hook-form";
|
|
@@ -5,6 +6,7 @@ import { UseTranslationResponse } from "react-i18next";
|
|
|
5
6
|
export interface SchemaFormContext<TData extends FieldValues> {
|
|
6
7
|
schema: JSONSchema7;
|
|
7
8
|
serverUrl: string;
|
|
9
|
+
requestUrl: string;
|
|
8
10
|
order: string[];
|
|
9
11
|
ignore: string[];
|
|
10
12
|
onSubmit?: (data: TData) => Promise<void>;
|
|
@@ -12,5 +14,6 @@ export interface SchemaFormContext<TData extends FieldValues> {
|
|
|
12
14
|
idMap: Record<string, object>;
|
|
13
15
|
setIdMap: Dispatch<SetStateAction<Record<string, object>>>;
|
|
14
16
|
translate: UseTranslationResponse<any, any>;
|
|
17
|
+
requestOptions: AxiosRequestConfig;
|
|
15
18
|
}
|
|
16
19
|
export declare const SchemaFormContext: import("react").Context<SchemaFormContext<unknown>>;
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
export declare const useSchemaContext: () => {
|
|
3
3
|
schema: import("json-schema").JSONSchema7;
|
|
4
4
|
serverUrl: string;
|
|
5
|
+
requestUrl: string;
|
|
5
6
|
order: string[];
|
|
6
7
|
ignore: string[];
|
|
7
8
|
onSubmit: ((data: unknown) => Promise<void>) | undefined;
|
|
@@ -9,4 +10,5 @@ export declare const useSchemaContext: () => {
|
|
|
9
10
|
idMap: Record<string, object>;
|
|
10
11
|
setIdMap: import("react").Dispatch<import("react").SetStateAction<Record<string, object>>>;
|
|
11
12
|
translate: import("react-i18next").UseTranslationResponse<any, any>;
|
|
13
|
+
requestOptions: import("axios").AxiosRequestConfig<any>;
|
|
12
14
|
};
|
package/dist/types/index.d.ts
CHANGED
|
@@ -58,16 +58,16 @@ declare module "@tanstack/react-table" {
|
|
|
58
58
|
}
|
|
59
59
|
}
|
|
60
60
|
export * from "./components/Controls/DensityToggleButton";
|
|
61
|
-
export * from "./components/Controls/
|
|
61
|
+
export * from "./components/Controls/FilterDialog";
|
|
62
62
|
export * from "./components/Controls/EditOrderButton";
|
|
63
63
|
export * from "./components/Controls/EditSortingButton";
|
|
64
|
-
export * from "./components/Controls/
|
|
64
|
+
export * from "./components/Controls/ViewDialog";
|
|
65
65
|
export * from "./components/Controls/PageSizeControl";
|
|
66
66
|
export * from "./components/Controls/ResetFilteringButton";
|
|
67
67
|
export * from "./components/Controls/ResetSelectionButton";
|
|
68
68
|
export * from "./components/Controls/ResetSortingButton";
|
|
69
69
|
export * from "./components/Controls/RowCountText";
|
|
70
|
-
export * from "./components/Controls/
|
|
70
|
+
export * from "./components/Controls/Pagination";
|
|
71
71
|
export * from "./components/DataTable/CardHeader";
|
|
72
72
|
export * from "./components/DataTable/DataDisplay";
|
|
73
73
|
export * from "./components/DataTable/DataTable";
|