gbs-add-block 1.0.31 → 1.2.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 CHANGED
@@ -1,4 +1,4 @@
1
- # GBS Building Blocks 2.0 (v1.0.30)
1
+ # GBS Building Blocks 2.0 (v1.2.0)
2
2
 
3
3
  Latest and upgraded version of GBS building blocks with headless UI and removed dependencies.
4
4
 
@@ -6,9 +6,12 @@ Latest and upgraded version of GBS building blocks with headless UI and removed
6
6
 
7
7
  For detailed documentation on usage and props, Please visit: [Building Block Documentation v2.0](https://gramprokit.vercel.app)
8
8
 
9
- ## What's New 🎉 (Ver 1.0.30)
9
+ ## What's New 🎉 (Ver 1.2.0)
10
10
 
11
- - Type Import Update
11
+ - Updated Data Grid
12
+ - Style Updates
13
+ - Bug Fix
14
+ - New Documentation Site
12
15
 
13
16
  ## Authors
14
17
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gbs-add-block",
3
- "version": "1.0.31",
3
+ "version": "1.2.0",
4
4
  "description": "React Component Library",
5
5
  "type": "module",
6
6
  "files": [
@@ -0,0 +1,82 @@
1
+ export const createTemplate = (
2
+ type: string,
3
+ config: any = {},
4
+ CustomTemplate?: any
5
+ ) => {
6
+ return ({ rowData }: { rowData: any }) => {
7
+ const field = config.field || "unknown";
8
+
9
+ const handleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
10
+ const value =
11
+ config.type === "number" ? Number(e.target.value) : e.target.value;
12
+ rowData[field] = value;
13
+ config.onDataChange?.(rowData.id, field, value);
14
+ };
15
+
16
+ const handleSelectChange = (e: React.ChangeEvent<HTMLSelectElement>) => {
17
+ rowData[field] = e.target.value;
18
+ config.onDataChange?.(rowData.id, field, e.target.value);
19
+ };
20
+
21
+ switch (type) {
22
+ case "input":
23
+ return (
24
+ <input
25
+ key={`${field}-${rowData.id}`}
26
+ type={config.type || "text"}
27
+ className={
28
+ config.className ||
29
+ "p-1 text-xs outline-none w-full rounded focus:border-b-2 border-blue-600"
30
+ }
31
+ placeholder={config.placeholder || `Enter ${field}`}
32
+ defaultValue={rowData[field]}
33
+ onChange={handleInputChange}
34
+ onBlur={handleInputChange}
35
+ />
36
+ );
37
+
38
+ case "select":
39
+ return (
40
+ <select
41
+ key={`${field}-${rowData.id}`}
42
+ className={
43
+ config.className ||
44
+ "p-1 w-full text-xs rounded outline-none focus:border-b-2 border-blue-600 dark:bg-zinc-900"
45
+ }
46
+ defaultValue={rowData[field]}
47
+ onChange={handleSelectChange}
48
+ >
49
+ {config.options?.map((option: any, i: number) => (
50
+ <option key={i} value={option.value || option}>
51
+ {option.label || option}
52
+ </option>
53
+ ))}
54
+ </select>
55
+ );
56
+
57
+ case "button":
58
+ return (
59
+ <button
60
+ key={`${field}-${rowData.id}`}
61
+ className={config.className || "border rounded-2xl p-1"}
62
+ onClick={() => config.onClick?.(rowData)}
63
+ >
64
+ {config.text || "Action"}
65
+ </button>
66
+ );
67
+
68
+ case "custom":
69
+ return (
70
+ <CustomTemplate
71
+ rowData={rowData}
72
+ field={field}
73
+ config={config}
74
+ {...config}
75
+ />
76
+ );
77
+
78
+ default:
79
+ return <span>{rowData[field]}</span>;
80
+ }
81
+ };
82
+ };
@@ -1,187 +0,0 @@
1
- import React, { createContext, useContext } from "react";
2
- import type { GridContextType, GridProps } from "../type";
3
- import {
4
- useDataSource,
5
- useColumns,
6
- usePagination,
7
- useSearch,
8
- useFiltering,
9
- useRowSelection,
10
- usePageStatus,
11
- } from "../hooks";
12
-
13
- const GridContext = createContext<GridContextType | undefined>(undefined);
14
-
15
- export const GridProvider: React.FC<{
16
- children: React.ReactNode;
17
- props: GridProps;
18
- }> = ({ children, props }) => {
19
- const {
20
- dataSource,
21
- columns = [],
22
- pageSettings,
23
- enableSearch = false,
24
- lazy = false,
25
- enableExcelExport = false,
26
- excelName = "data",
27
- enablePdfExport = false,
28
- pdfName = "data",
29
- pdfOptions = {},
30
- gridButtonClass = "px-1 py-2 text-xs rounded bg-zinc-200 dark:bg-zinc-700 cursor-pointer",
31
- selectAll = false,
32
- onSelectRow,
33
- isFetching,
34
- tableHeaderStyle = "text-left px-2 py-4 bg-zinc-200 dark:bg-zinc-800",
35
- gridContainerClass = "flex flex-col rounded-md overflow-hidden",
36
- gridColumnStyleSelectAll = "px-4 text-xs",
37
- gridColumnStyle = "p-2 text-xs",
38
- rowChange = () => {},
39
- pageStatus = () => {},
40
- activeFilterArrayValue = [],
41
- searchParamValue = () => {},
42
- showTotalPages = false,
43
- onSearch = () => {},
44
- onToolbarButtonClick = () => {},
45
- } = props;
46
-
47
- // Data source management
48
- const {
49
- workingDataSource,
50
- setWorkingDataSource,
51
- fallbackSourceData,
52
- totalPages,
53
- setTotalPages,
54
- } = useDataSource(dataSource, pageSettings, lazy);
55
-
56
- // Column management
57
- const { workingColumns, setWorkingColumns } = useColumns(
58
- columns,
59
- workingDataSource
60
- );
61
-
62
- // Pagination management
63
- const {
64
- currentPage,
65
- pageStart,
66
- pageEnd,
67
- nextPage,
68
- prevPage,
69
- goToEndPage,
70
- goToFirstPage,
71
- goToPage,
72
- resetPage,
73
- } = usePagination(totalPages, lazy, workingDataSource, pageSettings);
74
-
75
- // Search functionality
76
- const { searchParam, handleSearchInput, handleSearch } = useSearch({
77
- workingDataSource,
78
- setWorkingDataSource,
79
- fallbackSourceData,
80
- dataSource,
81
- lazy,
82
- pageSettings,
83
- resetPage,
84
- setTotalPages,
85
- searchParamValue,
86
- });
87
-
88
- // Filtering functionality
89
- const {
90
- activeFilterArray,
91
- toggleFilterPopup,
92
- handleApplyFilter,
93
- clearFilter,
94
- handleFilterAction,
95
- } = useFiltering({
96
- columns,
97
- workingColumns,
98
- setWorkingColumns,
99
- workingDataSource,
100
- setWorkingDataSource,
101
- dataSource,
102
- fallbackSourceData,
103
- resetPage,
104
- setTotalPages,
105
- pageSettings,
106
- activeFilterArrayValue,
107
- });
108
-
109
- // Row selection functionality
110
- const { selectedRows, handleSelectAll, handleSelect, isRowSelected } =
111
- useRowSelection(workingDataSource, onSelectRow);
112
-
113
- // Page status reporting
114
- usePageStatus(currentPage, totalPages, pageStatus);
115
-
116
- // Context value
117
- const contextValue: GridContextType = {
118
- // State
119
- workingDataSource,
120
- fallbackSourceData,
121
- workingColumns,
122
- currentPage,
123
- pageStart,
124
- pageEnd,
125
- totalPages,
126
- searchParam,
127
- activeFilterArray,
128
- selectedRows,
129
- isFetching,
130
-
131
- // Navigation methods
132
- nextPage,
133
- prevPage,
134
- goToEndPage,
135
- goToFirstPage,
136
- goToPage,
137
- lazy,
138
-
139
- // Search methods
140
- handleSearchInput,
141
- handleSearch,
142
-
143
- // Filter methods
144
- toggleFilterPopup,
145
- handleApplyFilter,
146
- clearFilter,
147
- handleFilterAction,
148
-
149
- // Row selection methods
150
- handleSelectAll,
151
- handleSelect,
152
- isRowSelected,
153
-
154
- // Grid settings
155
- columns,
156
- pageSettings,
157
- enableSearch,
158
- enableExcelExport,
159
- enablePdfExport,
160
- excelName,
161
- pdfName,
162
- pdfOptions,
163
- gridButtonClass,
164
- selectAll,
165
- tableHeaderStyle,
166
- gridContainerClass,
167
- gridColumnStyleSelectAll,
168
- gridColumnStyle,
169
- rowChange,
170
- showTotalPages,
171
- onSearch,
172
- onToolbarButtonClick,
173
- };
174
-
175
- return (
176
- <GridContext.Provider value={contextValue}>{children}</GridContext.Provider>
177
- );
178
- };
179
-
180
- // Base context hook
181
- export const useGridContext = () => {
182
- const context = useContext(GridContext);
183
- if (context === undefined) {
184
- throw new Error("useGridContext must be used within a GridProvider");
185
- }
186
- return context;
187
- };
@@ -1,7 +0,0 @@
1
- export { useDataSource } from "./useDataSource";
2
- export { useColumns } from "./useColumns";
3
- export { usePagination } from "./usePagination";
4
- export { useSearch } from "./useSearch";
5
- export { useFiltering } from "./useFiltering";
6
- export { useRowSelection } from "./useRowSelection";
7
- export { usePageStatus } from "./usePageStatus";
@@ -1,33 +0,0 @@
1
- import { useState, useEffect } from "react";
2
-
3
- export const useColumns = (columns: any[], workingDataSource: any[]) => {
4
- const [workingColumns, setWorkingColumns] = useState<any>([]);
5
-
6
- useEffect(() => {
7
- if (columns && columns.length > 0) {
8
- const filteredColumns = columns.map((column) => ({
9
- ...column,
10
- showFilterPopup: false,
11
- isFilterActive: false,
12
- }));
13
- setWorkingColumns(filteredColumns);
14
- } else if (
15
- workingDataSource.length > 0 &&
16
- Object.keys(workingDataSource[0]).length > 0
17
- ) {
18
- const inferredColumns = Object.keys(workingDataSource[0]).map((key) => ({
19
- field: key,
20
- headerText: key.charAt(0).toUpperCase() + key.slice(1),
21
- width: 150,
22
- }));
23
- setWorkingColumns((prevColumns: any) => {
24
- if (JSON.stringify(prevColumns) !== JSON.stringify(inferredColumns)) {
25
- return inferredColumns;
26
- }
27
- return prevColumns;
28
- });
29
- }
30
- }, [columns, workingDataSource]);
31
-
32
- return { workingColumns, setWorkingColumns };
33
- };
@@ -1,54 +0,0 @@
1
- import { useState, useCallback, useEffect } from "react";
2
- import { getSourceData } from "../../utils";
3
-
4
- export const useDataSource = (
5
- dataSource: any,
6
- pageSettings: any,
7
- lazy: boolean
8
- ) => {
9
- const [workingDataSource, setWorkingDataSource] = useState<any>([]);
10
- const [fallbackSourceData, setFallbackSourceData] = useState([]);
11
- const [totalPages, setTotalPages] = useState(0);
12
-
13
- const getGridData = useCallback(async () => {
14
- try {
15
- const sourceData = await getSourceData(dataSource);
16
- const gridData = sourceData.sourcedata;
17
- setFallbackSourceData(gridData);
18
- setWorkingDataSource(gridData);
19
- const totalPages = Math.ceil(gridData.length / pageSettings.pageNumber);
20
- setTotalPages(totalPages);
21
- return totalPages;
22
- } catch (error) {
23
- console.error("Error fetching grid source data:", error);
24
- return 0;
25
- }
26
- }, [dataSource, pageSettings.pageNumber]);
27
-
28
- useEffect(() => {
29
- const handleDataSource = async () => {
30
- if (Array.isArray(dataSource)) {
31
- setWorkingDataSource(dataSource);
32
-
33
- const totalPages =
34
- lazy && pageSettings.totalCount
35
- ? Math.ceil(pageSettings.totalCount / pageSettings.pageNumber)
36
- : Math.ceil(dataSource.length / pageSettings.pageNumber);
37
-
38
- setTotalPages(totalPages);
39
- } else if (typeof dataSource === "string") {
40
- await getGridData();
41
- }
42
- };
43
-
44
- handleDataSource();
45
- }, [dataSource, pageSettings, lazy, getGridData]);
46
-
47
- return {
48
- workingDataSource,
49
- setWorkingDataSource,
50
- fallbackSourceData,
51
- totalPages,
52
- setTotalPages,
53
- };
54
- };
@@ -1,135 +0,0 @@
1
- import { useState, useCallback } from "react";
2
- import {
3
- clearFilterHelper,
4
- handleApplyFilterHelper,
5
- } from "@grampro/headless-helpers";
6
-
7
- interface UseFilteringProps {
8
- columns: any[];
9
- workingColumns: any[];
10
- setWorkingColumns: (columns: any[]) => void;
11
- workingDataSource: any[];
12
- setWorkingDataSource: (data: any[]) => void;
13
- dataSource: any;
14
- fallbackSourceData: any[];
15
- resetPage: (data: any[], settings: any) => number;
16
- setTotalPages: (pages: number) => void;
17
- pageSettings: any;
18
- activeFilterArrayValue?: (filters: any[]) => void;
19
- }
20
-
21
- export const useFiltering = ({
22
- columns,
23
- workingColumns,
24
- setWorkingColumns,
25
- workingDataSource,
26
- setWorkingDataSource,
27
- dataSource,
28
- fallbackSourceData,
29
- resetPage,
30
- setTotalPages,
31
- pageSettings,
32
- activeFilterArrayValue,
33
- }: UseFilteringProps) => {
34
- const [activeFilterArray, setActiveFilterArray] = useState<any>([]);
35
-
36
- const toggleFilterPopup = useCallback(
37
- (index: number) => {
38
- setWorkingColumns(
39
- workingColumns.map((column: any, i: any) =>
40
- i === index
41
- ? { ...column, showFilterPopup: !column.showFilterPopup }
42
- : column
43
- )
44
- );
45
- },
46
- [workingColumns, setWorkingColumns]
47
- );
48
-
49
- const handleApplyFilter = useCallback(
50
- (event: any) => {
51
- const {
52
- columns: updatedColumns,
53
- workingDataSource: updatedFullDataSource,
54
- activeFilterArray: updatedActiveFilterArray,
55
- } = handleApplyFilterHelper(event, columns, workingDataSource);
56
-
57
- setWorkingColumns(updatedColumns);
58
- setWorkingDataSource(updatedFullDataSource);
59
- setActiveFilterArray(updatedActiveFilterArray);
60
- if (activeFilterArrayValue)
61
- activeFilterArrayValue(updatedActiveFilterArray);
62
- const totalPages = resetPage(updatedFullDataSource, pageSettings);
63
- setTotalPages(totalPages);
64
- },
65
- [
66
- columns,
67
- workingDataSource,
68
- setWorkingColumns,
69
- setWorkingDataSource,
70
- activeFilterArrayValue,
71
- resetPage,
72
- pageSettings,
73
- setTotalPages,
74
- ]
75
- );
76
-
77
- const clearFilter = useCallback(
78
- (event: any) => {
79
- const clearDataSource = Array.isArray(dataSource)
80
- ? dataSource
81
- : fallbackSourceData;
82
- const {
83
- columns: updatedColumns,
84
- workingDataSource: updatedDataSource,
85
- activeFilterArray: updatedActiveFilterArray,
86
- } = clearFilterHelper(event, workingColumns, clearDataSource);
87
-
88
- setWorkingColumns(updatedColumns);
89
- setWorkingDataSource(updatedDataSource);
90
- setActiveFilterArray(updatedActiveFilterArray);
91
- if (activeFilterArrayValue)
92
- activeFilterArrayValue(updatedActiveFilterArray);
93
- const totalPages = resetPage(updatedDataSource, pageSettings);
94
- setTotalPages(totalPages);
95
- },
96
- [
97
- dataSource,
98
- fallbackSourceData,
99
- workingColumns,
100
- setWorkingColumns,
101
- setWorkingDataSource,
102
- activeFilterArrayValue,
103
- resetPage,
104
- pageSettings,
105
- setTotalPages,
106
- ]
107
- );
108
-
109
- const handleFilterAction = useCallback(
110
- (action: any, colIndex: number) => {
111
- switch (action.type) {
112
- case "cancel":
113
- toggleFilterPopup(colIndex);
114
- break;
115
- case "applyFilter":
116
- handleApplyFilter(action);
117
- break;
118
- case "clearFilter":
119
- clearFilter(action);
120
- break;
121
- default:
122
- break;
123
- }
124
- },
125
- [toggleFilterPopup, handleApplyFilter, clearFilter]
126
- );
127
-
128
- return {
129
- activeFilterArray,
130
- toggleFilterPopup,
131
- handleApplyFilter,
132
- clearFilter,
133
- handleFilterAction,
134
- };
135
- };
@@ -1,13 +0,0 @@
1
- import { useEffect } from "react";
2
-
3
- export const usePageStatus = (
4
- currentPage: number,
5
- totalPages: number,
6
- pageStatus?: (status: any) => void
7
- ) => {
8
- useEffect(() => {
9
- if (pageStatus) {
10
- pageStatus({ currentPage, totalPages });
11
- }
12
- }, [pageStatus, currentPage, totalPages]);
13
- };
@@ -1,125 +0,0 @@
1
- import { useState, useCallback, useEffect } from "react";
2
-
3
- export const usePagination = (
4
- totalPages: number,
5
- lazy: boolean,
6
- dataSource?: any[],
7
- pageSettings?: { pageNumber: number }
8
- ) => {
9
- const [currentPage, setCurrentPage] = useState(0);
10
- const [pageStart, setPageStart] = useState(0);
11
- const [pageEnd, setPageEnd] = useState(10);
12
- const [prevDataLength, setPrevDataLength] = useState(0);
13
-
14
- const updatePageRange = useCallback(
15
- (page: number) => {
16
- const start = Math.floor(page / 10) * 10;
17
- setPageStart(start);
18
- setPageEnd(Math.min(start + 10, totalPages));
19
- },
20
- [totalPages]
21
- );
22
-
23
- useEffect(() => {
24
- if (!lazy) {
25
- setPageEnd(Math.min(10, totalPages));
26
- } else {
27
- setPageEnd(Math.min(pageStart + 10, totalPages));
28
- }
29
- }, [totalPages, lazy, pageStart]);
30
-
31
- // This will handle the case when dataSource changes
32
- // and adjust the current page accordingly
33
- useEffect(() => {
34
- if (dataSource && prevDataLength > 0) {
35
- const currentDataLength = dataSource.length;
36
-
37
- if (currentDataLength > prevDataLength) {
38
- const lastPage = totalPages - 1;
39
- setCurrentPage(lastPage);
40
- updatePageRange(lastPage);
41
- } else if (currentDataLength < prevDataLength) {
42
- const rowsPerPage = lazy ? 1 : pageSettings?.pageNumber || 10;
43
- const startIndex = currentPage * rowsPerPage;
44
-
45
- if (startIndex >= currentDataLength && currentPage > 0) {
46
- const newPage = currentPage - 1;
47
- setCurrentPage(newPage);
48
- updatePageRange(newPage);
49
- }
50
- }
51
- }
52
- setPrevDataLength(dataSource?.length || 0);
53
- }, [
54
- dataSource?.length,
55
- totalPages,
56
- updatePageRange,
57
- prevDataLength,
58
- currentPage,
59
- lazy,
60
- ]);
61
-
62
- const nextPage = useCallback(() => {
63
- setCurrentPage((prevPage) => {
64
- if (prevPage < totalPages - 1) {
65
- const newPage = prevPage + 1;
66
- updatePageRange(newPage);
67
- return newPage;
68
- }
69
- return prevPage;
70
- });
71
- }, [totalPages, updatePageRange]);
72
-
73
- const prevPage = useCallback(() => {
74
- setCurrentPage((prevPage) => {
75
- if (prevPage > 0) {
76
- const newPage = prevPage - 1;
77
- updatePageRange(newPage);
78
- return newPage;
79
- }
80
- return prevPage;
81
- });
82
- }, [updatePageRange]);
83
-
84
- const goToEndPage = useCallback(() => {
85
- const lastPage = totalPages - 1;
86
- setCurrentPage(lastPage);
87
- updatePageRange(lastPage);
88
- }, [totalPages, updatePageRange]);
89
-
90
- const goToFirstPage = useCallback(() => {
91
- setCurrentPage(0);
92
- updatePageRange(0);
93
- }, [updatePageRange]);
94
-
95
- const goToPage = useCallback(
96
- (page: number) => {
97
- setCurrentPage(page);
98
- updatePageRange(page);
99
- },
100
- [updatePageRange]
101
- );
102
-
103
- const resetPage = useCallback((dataSource: any, pageSettings: any) => {
104
- const newTotalPages = Math.ceil(
105
- dataSource.length / pageSettings.pageNumber
106
- );
107
- setCurrentPage(0);
108
- setPageStart(0);
109
- setPageEnd(Math.min(10, newTotalPages));
110
- return newTotalPages;
111
- }, []);
112
-
113
- return {
114
- currentPage,
115
- pageStart,
116
- pageEnd,
117
- nextPage,
118
- prevPage,
119
- goToEndPage,
120
- goToFirstPage,
121
- goToPage,
122
- resetPage,
123
- updatePageRange,
124
- };
125
- };