@patternfly/react-data-view 6.1.0-prerelease.1 → 6.1.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/dist/cjs/DataView/DataView.d.ts +15 -1
- package/dist/cjs/DataView/DataView.js +14 -3
- package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.d.ts +29 -0
- package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.js +70 -0
- package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.test.d.ts +1 -0
- package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.test.js +25 -0
- package/dist/cjs/DataViewCheckboxFilter/index.d.ts +2 -0
- package/dist/cjs/DataViewCheckboxFilter/index.js +23 -0
- package/dist/cjs/DataViewEventsContext/DataViewEventsContext.d.ts +16 -0
- package/dist/cjs/DataViewEventsContext/DataViewEventsContext.js +62 -0
- package/dist/cjs/DataViewEventsContext/DataViewEventsContext.test.d.ts +1 -0
- package/dist/cjs/DataViewEventsContext/DataViewEventsContext.test.js +72 -0
- package/dist/cjs/DataViewEventsContext/index.d.ts +2 -0
- package/dist/cjs/DataViewEventsContext/index.js +23 -0
- package/dist/cjs/DataViewFilters/DataViewFilters.d.ts +25 -0
- package/dist/cjs/DataViewFilters/DataViewFilters.js +85 -0
- package/dist/cjs/DataViewFilters/DataViewFilters.test.d.ts +1 -0
- package/dist/cjs/DataViewFilters/DataViewFilters.test.js +19 -0
- package/dist/cjs/DataViewFilters/index.d.ts +2 -0
- package/dist/cjs/DataViewFilters/index.js +23 -0
- package/dist/cjs/DataViewTable/DataViewTable.d.ts +49 -0
- package/dist/cjs/DataViewTable/DataViewTable.js +18 -0
- package/dist/cjs/DataViewTable/DataViewTable.test.d.ts +1 -0
- package/dist/cjs/DataViewTable/DataViewTable.test.js +57 -0
- package/dist/cjs/DataViewTable/index.d.ts +2 -0
- package/dist/cjs/DataViewTable/index.js +23 -0
- package/dist/cjs/DataViewTableBasic/DataViewTableBasic.d.ts +19 -0
- package/dist/cjs/DataViewTableBasic/DataViewTableBasic.js +71 -0
- package/dist/cjs/DataViewTableBasic/DataViewTableBasic.test.d.ts +1 -0
- package/dist/cjs/DataViewTableBasic/DataViewTableBasic.test.js +43 -0
- package/dist/cjs/DataViewTableBasic/index.d.ts +2 -0
- package/dist/cjs/DataViewTableBasic/index.js +23 -0
- package/dist/cjs/DataViewTableHead/DataViewTableHead.d.ts +14 -0
- package/dist/cjs/DataViewTableHead/DataViewTableHead.js +57 -0
- package/dist/cjs/DataViewTableHead/DataViewTableHead.test.d.ts +1 -0
- package/dist/cjs/DataViewTableHead/DataViewTableHead.test.js +36 -0
- package/dist/cjs/DataViewTableHead/index.d.ts +2 -0
- package/dist/cjs/DataViewTableHead/index.js +23 -0
- package/dist/cjs/DataViewTableTree/DataViewTableTree.d.ts +25 -0
- package/dist/cjs/DataViewTableTree/DataViewTableTree.js +144 -0
- package/dist/cjs/DataViewTableTree/DataViewTableTree.test.d.ts +1 -0
- package/dist/cjs/DataViewTableTree/DataViewTableTree.test.js +90 -0
- package/dist/cjs/DataViewTableTree/index.d.ts +2 -0
- package/dist/cjs/DataViewTableTree/index.js +23 -0
- package/dist/cjs/DataViewTextFilter/DataViewTextFilter.d.ts +21 -0
- package/dist/cjs/DataViewTextFilter/DataViewTextFilter.js +26 -0
- package/dist/cjs/DataViewTextFilter/DataViewTextFilter.test.d.ts +1 -0
- package/dist/cjs/DataViewTextFilter/DataViewTextFilter.test.js +22 -0
- package/dist/cjs/DataViewTextFilter/index.d.ts +2 -0
- package/dist/cjs/DataViewTextFilter/index.js +23 -0
- package/dist/cjs/DataViewToolbar/DataViewToolbar.d.ts +11 -3
- package/dist/cjs/DataViewToolbar/DataViewToolbar.js +30 -6
- package/dist/cjs/Hooks/filters.d.ts +14 -0
- package/dist/cjs/Hooks/filters.js +69 -0
- package/dist/cjs/Hooks/filters.test.d.ts +1 -0
- package/dist/cjs/Hooks/filters.test.js +50 -0
- package/dist/cjs/Hooks/index.d.ts +2 -0
- package/dist/cjs/Hooks/index.js +2 -0
- package/dist/cjs/Hooks/pagination.d.ts +14 -1
- package/dist/cjs/Hooks/pagination.js +36 -4
- package/dist/cjs/Hooks/pagination.test.js +1 -1
- package/dist/cjs/Hooks/selection.d.ts +3 -3
- package/dist/cjs/Hooks/selection.js +4 -4
- package/dist/cjs/Hooks/selection.test.js +4 -4
- package/dist/cjs/Hooks/sort.d.ts +32 -0
- package/dist/cjs/Hooks/sort.js +47 -0
- package/dist/cjs/Hooks/sort.test.d.ts +1 -0
- package/dist/cjs/Hooks/sort.test.js +68 -0
- package/dist/cjs/InternalContext/InternalContext.d.ts +26 -0
- package/dist/cjs/InternalContext/InternalContext.js +40 -0
- package/dist/cjs/InternalContext/InternalContext.test.d.ts +1 -0
- package/dist/cjs/InternalContext/InternalContext.test.js +56 -0
- package/dist/cjs/InternalContext/index.d.ts +2 -0
- package/dist/cjs/InternalContext/index.js +23 -0
- package/dist/cjs/index.d.ts +16 -0
- package/dist/cjs/index.js +26 -2
- package/dist/dynamic/DataViewCheckboxFilter/package.json +1 -0
- package/dist/dynamic/DataViewEventsContext/package.json +1 -0
- package/dist/dynamic/DataViewFilters/package.json +1 -0
- package/dist/dynamic/DataViewTable/package.json +1 -0
- package/dist/dynamic/DataViewTableBasic/package.json +1 -0
- package/dist/dynamic/DataViewTableHead/package.json +1 -0
- package/dist/dynamic/DataViewTableTree/package.json +1 -0
- package/dist/dynamic/DataViewTextFilter/package.json +1 -0
- package/dist/dynamic/InternalContext/package.json +1 -0
- package/dist/esm/DataView/DataView.d.ts +15 -1
- package/dist/esm/DataView/DataView.js +13 -2
- package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.d.ts +29 -0
- package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.js +62 -0
- package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.test.d.ts +1 -0
- package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.test.js +20 -0
- package/dist/esm/DataViewCheckboxFilter/index.d.ts +2 -0
- package/dist/esm/DataViewCheckboxFilter/index.js +2 -0
- package/dist/esm/DataViewEventsContext/DataViewEventsContext.d.ts +16 -0
- package/dist/esm/DataViewEventsContext/DataViewEventsContext.js +34 -0
- package/dist/esm/DataViewEventsContext/DataViewEventsContext.test.d.ts +1 -0
- package/dist/esm/DataViewEventsContext/DataViewEventsContext.test.js +67 -0
- package/dist/esm/DataViewEventsContext/index.d.ts +2 -0
- package/dist/esm/DataViewEventsContext/index.js +2 -0
- package/dist/esm/DataViewFilters/DataViewFilters.d.ts +25 -0
- package/dist/esm/DataViewFilters/DataViewFilters.js +58 -0
- package/dist/esm/DataViewFilters/DataViewFilters.test.d.ts +1 -0
- package/dist/esm/DataViewFilters/DataViewFilters.test.js +14 -0
- package/dist/esm/DataViewFilters/index.d.ts +2 -0
- package/dist/esm/DataViewFilters/index.js +2 -0
- package/dist/esm/DataViewTable/DataViewTable.d.ts +49 -0
- package/dist/esm/DataViewTable/DataViewTable.js +8 -0
- package/dist/esm/DataViewTable/DataViewTable.test.d.ts +1 -0
- package/dist/esm/DataViewTable/DataViewTable.test.js +52 -0
- package/dist/esm/DataViewTable/index.d.ts +2 -0
- package/dist/esm/DataViewTable/index.js +2 -0
- package/dist/esm/DataViewTableBasic/DataViewTableBasic.d.ts +19 -0
- package/dist/esm/DataViewTableBasic/DataViewTableBasic.js +44 -0
- package/dist/esm/DataViewTableBasic/DataViewTableBasic.test.d.ts +1 -0
- package/dist/esm/DataViewTableBasic/DataViewTableBasic.test.js +38 -0
- package/dist/esm/DataViewTableBasic/index.d.ts +2 -0
- package/dist/esm/DataViewTableBasic/index.js +2 -0
- package/dist/esm/DataViewTableHead/DataViewTableHead.d.ts +14 -0
- package/dist/esm/DataViewTableHead/DataViewTableHead.js +30 -0
- package/dist/esm/DataViewTableHead/DataViewTableHead.test.d.ts +1 -0
- package/dist/esm/DataViewTableHead/DataViewTableHead.test.js +31 -0
- package/dist/esm/DataViewTableHead/index.d.ts +2 -0
- package/dist/esm/DataViewTableHead/index.js +2 -0
- package/dist/esm/DataViewTableTree/DataViewTableTree.d.ts +25 -0
- package/dist/esm/DataViewTableTree/DataViewTableTree.js +117 -0
- package/dist/esm/DataViewTableTree/DataViewTableTree.test.d.ts +1 -0
- package/dist/esm/DataViewTableTree/DataViewTableTree.test.js +85 -0
- package/dist/esm/DataViewTableTree/index.d.ts +2 -0
- package/dist/esm/DataViewTableTree/index.js +2 -0
- package/dist/esm/DataViewTextFilter/DataViewTextFilter.d.ts +21 -0
- package/dist/esm/DataViewTextFilter/DataViewTextFilter.js +19 -0
- package/dist/esm/DataViewTextFilter/DataViewTextFilter.test.d.ts +1 -0
- package/dist/esm/DataViewTextFilter/DataViewTextFilter.test.js +17 -0
- package/dist/esm/DataViewTextFilter/index.d.ts +2 -0
- package/dist/esm/DataViewTextFilter/index.js +2 -0
- package/dist/esm/DataViewToolbar/DataViewToolbar.d.ts +11 -3
- package/dist/esm/DataViewToolbar/DataViewToolbar.js +8 -4
- package/dist/esm/Hooks/filters.d.ts +14 -0
- package/dist/esm/Hooks/filters.js +65 -0
- package/dist/esm/Hooks/filters.test.d.ts +1 -0
- package/dist/esm/Hooks/filters.test.js +48 -0
- package/dist/esm/Hooks/index.d.ts +2 -0
- package/dist/esm/Hooks/index.js +2 -0
- package/dist/esm/Hooks/pagination.d.ts +14 -1
- package/dist/esm/Hooks/pagination.js +36 -4
- package/dist/esm/Hooks/pagination.test.js +1 -1
- package/dist/esm/Hooks/selection.d.ts +3 -3
- package/dist/esm/Hooks/selection.js +4 -4
- package/dist/esm/Hooks/selection.test.js +4 -4
- package/dist/esm/Hooks/sort.d.ts +32 -0
- package/dist/esm/Hooks/sort.js +43 -0
- package/dist/esm/Hooks/sort.test.d.ts +1 -0
- package/dist/esm/Hooks/sort.test.js +66 -0
- package/dist/esm/InternalContext/InternalContext.d.ts +26 -0
- package/dist/esm/InternalContext/InternalContext.js +12 -0
- package/dist/esm/InternalContext/InternalContext.test.d.ts +1 -0
- package/dist/esm/InternalContext/InternalContext.test.js +51 -0
- package/dist/esm/InternalContext/index.d.ts +2 -0
- package/dist/esm/InternalContext/index.js +2 -0
- package/dist/esm/index.d.ts +16 -0
- package/dist/esm/index.js +16 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +16 -15
- package/patternfly-docs/content/extensions/data-view/examples/DataView/DataView.md +63 -0
- package/patternfly-docs/content/extensions/data-view/examples/DataView/EventsExample.tsx +130 -0
- package/patternfly-docs/content/extensions/data-view/examples/DataView/PredefinedLayoutFullExample.tsx +275 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableEmptyExample.tsx +57 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableErrorExample.tsx +45 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableExample.tsx +67 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableLoadingExample.tsx +27 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableTreeExample.tsx +71 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/SortingExample.tsx +87 -0
- package/patternfly-docs/content/extensions/data-view/examples/Table/Table.md +130 -0
- package/patternfly-docs/content/extensions/data-view/examples/Toolbar/DataViewToolbarActionsExample.tsx +27 -0
- package/patternfly-docs/content/extensions/data-view/examples/Toolbar/DataViewToolbarExample.tsx +36 -0
- package/patternfly-docs/content/extensions/data-view/examples/Toolbar/FiltersExample.tsx +107 -0
- package/patternfly-docs/content/extensions/data-view/examples/Toolbar/PaginationExample.tsx +56 -0
- package/patternfly-docs/content/extensions/data-view/examples/Toolbar/SelectionExample.tsx +57 -0
- package/patternfly-docs/content/extensions/data-view/examples/Toolbar/Toolbar.md +142 -0
- package/patternfly-docs/pages/index.js +1 -1
- package/src/DataView/DataView.tsx +28 -5
- package/src/DataView/__snapshots__/DataView.test.tsx.snap +2 -2
- package/src/DataViewCheckboxFilter/DataViewCheckboxFilter.test.tsx +24 -0
- package/src/DataViewCheckboxFilter/DataViewCheckboxFilter.tsx +175 -0
- package/src/DataViewCheckboxFilter/__snapshots__/DataViewCheckboxFilter.test.tsx.snap +197 -0
- package/src/DataViewCheckboxFilter/index.ts +2 -0
- package/src/DataViewEventsContext/DataViewEventsContext.test.tsx +105 -0
- package/src/DataViewEventsContext/DataViewEventsContext.tsx +70 -0
- package/src/DataViewEventsContext/index.ts +2 -0
- package/src/DataViewFilters/DataViewFilters.test.tsx +21 -0
- package/src/DataViewFilters/DataViewFilters.tsx +144 -0
- package/src/DataViewFilters/__snapshots__/DataViewFilters.test.tsx.snap +194 -0
- package/src/DataViewFilters/index.tsx +2 -0
- package/src/DataViewTable/DataViewTable.test.tsx +80 -0
- package/src/DataViewTable/DataViewTable.tsx +57 -0
- package/src/DataViewTable/__snapshots__/DataViewTable.test.tsx.snap +1042 -0
- package/src/DataViewTable/index.ts +2 -0
- package/src/DataViewTableBasic/DataViewTableBasic.test.tsx +65 -0
- package/src/DataViewTableBasic/DataViewTableBasic.tsx +83 -0
- package/src/DataViewTableBasic/__snapshots__/DataViewTableBasic.test.tsx.snap +555 -0
- package/src/DataViewTableBasic/index.ts +2 -0
- package/src/DataViewTableHead/DataViewTableHead.test.tsx +50 -0
- package/src/DataViewTableHead/DataViewTableHead.tsx +54 -0
- package/src/DataViewTableHead/__snapshots__/DataViewTableHead.test.tsx.snap +227 -0
- package/src/DataViewTableHead/index.ts +2 -0
- package/src/DataViewTableTree/DataViewTableTree.test.tsx +113 -0
- package/src/DataViewTableTree/DataViewTableTree.tsx +186 -0
- package/src/DataViewTableTree/__snapshots__/DataViewTableTree.test.tsx.snap +1200 -0
- package/src/DataViewTableTree/index.ts +2 -0
- package/src/DataViewTextFilter/DataViewTextFilter.test.tsx +24 -0
- package/src/DataViewTextFilter/DataViewTextFilter.tsx +54 -0
- package/src/DataViewTextFilter/__snapshots__/DataViewTextFilter.test.tsx.snap +203 -0
- package/src/DataViewTextFilter/index.ts +2 -0
- package/src/DataViewToolbar/DataViewToolbar.tsx +48 -22
- package/src/DataViewToolbar/__snapshots__/DataViewToolbar.test.tsx.snap +52 -8
- package/src/Hooks/filters.test.tsx +62 -0
- package/src/Hooks/filters.ts +97 -0
- package/src/Hooks/index.ts +2 -0
- package/src/Hooks/pagination.test.tsx +1 -1
- package/src/Hooks/pagination.ts +69 -12
- package/src/Hooks/selection.test.tsx +5 -5
- package/src/Hooks/selection.ts +7 -7
- package/src/Hooks/sort.test.tsx +84 -0
- package/src/Hooks/sort.ts +87 -0
- package/src/InternalContext/InternalContext.test.tsx +89 -0
- package/src/InternalContext/InternalContext.tsx +52 -0
- package/src/InternalContext/index.ts +2 -0
- package/src/index.ts +24 -0
- package/patternfly-docs/content/extensions/data-view/about-data-view.md +0 -14
- package/patternfly-docs/content/extensions/data-view/examples/Components/Components.md +0 -31
- package/patternfly-docs/content/extensions/data-view/examples/Components/DataViewToolbarExample.tsx +0 -20
- package/patternfly-docs/content/extensions/data-view/examples/Functionality/Functionality.md +0 -77
- package/patternfly-docs/content/extensions/data-view/examples/Functionality/PaginationExample.tsx +0 -65
- package/patternfly-docs/content/extensions/data-view/examples/Functionality/SelectionExample.tsx +0 -88
- package/patternfly-docs/content/extensions/data-view/examples/Layout/Layout.md +0 -39
- package/patternfly-docs/content/extensions/data-view/examples/Layout/PredefinedLayoutExample.tsx +0 -120
- /package/patternfly-docs/content/extensions/data-view/examples/{Layout → DataView}/AbstractLayoutExample.tsx +0 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { ISortBy } from "@patternfly/react-table";
|
|
2
|
+
export declare enum DataViewSortParams {
|
|
3
|
+
SORT_BY = "sortBy",
|
|
4
|
+
DIRECTION = "direction"
|
|
5
|
+
}
|
|
6
|
+
export interface DataViewSortConfig {
|
|
7
|
+
/** Attribute to sort the entries by */
|
|
8
|
+
sortBy: string | undefined;
|
|
9
|
+
/** Sort direction */
|
|
10
|
+
direction: ISortBy['direction'];
|
|
11
|
+
}
|
|
12
|
+
export interface UseDataViewSortProps {
|
|
13
|
+
/** Initial sort config */
|
|
14
|
+
initialSort?: DataViewSortConfig;
|
|
15
|
+
/** Current search parameters as a string */
|
|
16
|
+
searchParams?: URLSearchParams;
|
|
17
|
+
/** Function to set search parameters */
|
|
18
|
+
setSearchParams?: (params: URLSearchParams) => void;
|
|
19
|
+
/** Default direction */
|
|
20
|
+
defaultDirection?: ISortBy['direction'];
|
|
21
|
+
/** Sort by URL param name */
|
|
22
|
+
sortByParam?: string;
|
|
23
|
+
/** Direction URL param name */
|
|
24
|
+
directionParam?: string;
|
|
25
|
+
}
|
|
26
|
+
export declare const useDataViewSort: (props?: UseDataViewSortProps) => {
|
|
27
|
+
onSort: (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newSortBy: string, newSortDirection: ISortBy["direction"]) => void;
|
|
28
|
+
/** Attribute to sort the entries by */
|
|
29
|
+
sortBy: string | undefined;
|
|
30
|
+
/** Sort direction */
|
|
31
|
+
direction: ISortBy["direction"];
|
|
32
|
+
};
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.useDataViewSort = exports.DataViewSortParams = void 0;
|
|
4
|
+
const react_1 = require("react");
|
|
5
|
+
var DataViewSortParams;
|
|
6
|
+
(function (DataViewSortParams) {
|
|
7
|
+
DataViewSortParams["SORT_BY"] = "sortBy";
|
|
8
|
+
DataViewSortParams["DIRECTION"] = "direction";
|
|
9
|
+
})(DataViewSortParams || (exports.DataViewSortParams = DataViewSortParams = {}));
|
|
10
|
+
;
|
|
11
|
+
const validateDirection = (direction, defaultDirection) => (direction === 'asc' || direction === 'desc' ? direction : defaultDirection);
|
|
12
|
+
;
|
|
13
|
+
;
|
|
14
|
+
const useDataViewSort = (props) => {
|
|
15
|
+
var _a;
|
|
16
|
+
const { initialSort, searchParams, setSearchParams, defaultDirection = 'asc', sortByParam = DataViewSortParams.SORT_BY, directionParam = DataViewSortParams.DIRECTION } = props !== null && props !== void 0 ? props : {};
|
|
17
|
+
const isUrlSyncEnabled = (0, react_1.useMemo)(() => searchParams && !!setSearchParams, [searchParams, setSearchParams]);
|
|
18
|
+
const [state, setState] = (0, react_1.useState)({
|
|
19
|
+
sortBy: (_a = searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(sortByParam)) !== null && _a !== void 0 ? _a : initialSort === null || initialSort === void 0 ? void 0 : initialSort.sortBy,
|
|
20
|
+
direction: validateDirection(searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(directionParam), initialSort === null || initialSort === void 0 ? void 0 : initialSort.direction),
|
|
21
|
+
});
|
|
22
|
+
const updateSearchParams = (sortBy, direction) => {
|
|
23
|
+
if (isUrlSyncEnabled && sortBy) {
|
|
24
|
+
const params = new URLSearchParams(searchParams);
|
|
25
|
+
params.set(sortByParam, `${sortBy}`);
|
|
26
|
+
params.set(directionParam, `${direction}`);
|
|
27
|
+
setSearchParams === null || setSearchParams === void 0 ? void 0 : setSearchParams(params);
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
(0, react_1.useEffect)(() => {
|
|
31
|
+
state.sortBy && state.direction && updateSearchParams(state.sortBy, state.direction);
|
|
32
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
33
|
+
}, []);
|
|
34
|
+
(0, react_1.useEffect)(() => {
|
|
35
|
+
const currentSortBy = (searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(sortByParam)) || state.sortBy;
|
|
36
|
+
const currentDirection = (searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(directionParam)) || state.direction;
|
|
37
|
+
const validDirection = validateDirection(currentDirection, defaultDirection);
|
|
38
|
+
currentSortBy !== state.sortBy || validDirection !== state.direction && setState({ sortBy: currentSortBy, direction: validDirection });
|
|
39
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
40
|
+
}, [searchParams === null || searchParams === void 0 ? void 0 : searchParams.toString()]);
|
|
41
|
+
const onSort = (_event, newSortBy, newSortDirection) => {
|
|
42
|
+
setState({ sortBy: newSortBy, direction: newSortDirection });
|
|
43
|
+
updateSearchParams(newSortBy, newSortDirection);
|
|
44
|
+
};
|
|
45
|
+
return Object.assign(Object.assign({}, state), { onSort });
|
|
46
|
+
};
|
|
47
|
+
exports.useDataViewSort = useDataViewSort;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
require("@testing-library/jest-dom");
|
|
4
|
+
const react_1 = require("@testing-library/react");
|
|
5
|
+
const sort_1 = require("./sort");
|
|
6
|
+
describe('useDataViewSort', () => {
|
|
7
|
+
const initialSort = { sortBy: 'name', direction: 'asc' };
|
|
8
|
+
it('should initialize with provided initial sort config', () => {
|
|
9
|
+
const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)({ initialSort }));
|
|
10
|
+
expect(result.current).toEqual(expect.objectContaining(initialSort));
|
|
11
|
+
});
|
|
12
|
+
it('should initialize with empty sort config if no initialSort is provided', () => {
|
|
13
|
+
const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)());
|
|
14
|
+
expect(result.current).toEqual(expect.objectContaining({ sortBy: undefined, direction: 'asc' }));
|
|
15
|
+
});
|
|
16
|
+
it('should update sort state when onSort is called', () => {
|
|
17
|
+
const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)({ initialSort }));
|
|
18
|
+
(0, react_1.act)(() => {
|
|
19
|
+
result.current.onSort(undefined, 'age', 'desc');
|
|
20
|
+
});
|
|
21
|
+
expect(result.current).toEqual(expect.objectContaining({ sortBy: 'age', direction: 'desc' }));
|
|
22
|
+
});
|
|
23
|
+
it('should sync with URL search params if isUrlSyncEnabled', () => {
|
|
24
|
+
const searchParams = new URLSearchParams();
|
|
25
|
+
const setSearchParams = jest.fn();
|
|
26
|
+
const props = {
|
|
27
|
+
initialSort,
|
|
28
|
+
searchParams,
|
|
29
|
+
setSearchParams,
|
|
30
|
+
};
|
|
31
|
+
const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)(props));
|
|
32
|
+
expect(setSearchParams).toHaveBeenCalledTimes(1);
|
|
33
|
+
expect(result.current).toEqual(expect.objectContaining(initialSort));
|
|
34
|
+
});
|
|
35
|
+
it('should validate direction and fallback to default direction if invalid direction is provided', () => {
|
|
36
|
+
const searchParams = new URLSearchParams();
|
|
37
|
+
searchParams.set(sort_1.DataViewSortParams.SORT_BY, 'name');
|
|
38
|
+
searchParams.set(sort_1.DataViewSortParams.DIRECTION, 'invalid-direction');
|
|
39
|
+
const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)({ searchParams, defaultDirection: 'desc' }));
|
|
40
|
+
expect(result.current).toEqual(expect.objectContaining({ sortBy: 'name', direction: 'desc' }));
|
|
41
|
+
});
|
|
42
|
+
it('should update search params when URL sync is enabled and sort changes', () => {
|
|
43
|
+
const searchParams = new URLSearchParams();
|
|
44
|
+
const setSearchParams = jest.fn();
|
|
45
|
+
const props = {
|
|
46
|
+
initialSort,
|
|
47
|
+
searchParams,
|
|
48
|
+
setSearchParams,
|
|
49
|
+
};
|
|
50
|
+
const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)(props));
|
|
51
|
+
(0, react_1.act)(() => {
|
|
52
|
+
expect(setSearchParams).toHaveBeenCalledTimes(1);
|
|
53
|
+
result.current.onSort(undefined, 'priority', 'desc');
|
|
54
|
+
});
|
|
55
|
+
expect(setSearchParams).toHaveBeenCalledTimes(2);
|
|
56
|
+
expect(result.current).toEqual(expect.objectContaining({ sortBy: 'priority', direction: 'desc' }));
|
|
57
|
+
});
|
|
58
|
+
it('should prioritize searchParams values', () => {
|
|
59
|
+
const searchParams = new URLSearchParams();
|
|
60
|
+
searchParams.set(sort_1.DataViewSortParams.SORT_BY, 'category');
|
|
61
|
+
searchParams.set(sort_1.DataViewSortParams.DIRECTION, 'desc');
|
|
62
|
+
const { result } = (0, react_1.renderHook)((props) => (0, sort_1.useDataViewSort)(props), { initialProps: { initialSort, searchParams } });
|
|
63
|
+
expect(result.current).toEqual(expect.objectContaining({
|
|
64
|
+
sortBy: 'category',
|
|
65
|
+
direction: 'desc',
|
|
66
|
+
}));
|
|
67
|
+
});
|
|
68
|
+
});
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import React, { PropsWithChildren } from 'react';
|
|
2
|
+
import { DataViewState } from '../DataView';
|
|
3
|
+
export interface DataViewSelection {
|
|
4
|
+
/** Called when the selection of items changes */
|
|
5
|
+
onSelect: (isSelecting: boolean, items?: any[] | any) => void;
|
|
6
|
+
/** Checks if a specific item is currently selected */
|
|
7
|
+
isSelected: (item: any) => boolean;
|
|
8
|
+
/** Determines if selection is disabled for a given item */
|
|
9
|
+
isSelectDisabled?: (item: any) => boolean;
|
|
10
|
+
}
|
|
11
|
+
export interface InternalContextProps {
|
|
12
|
+
/** Data selection props */
|
|
13
|
+
selection?: DataViewSelection;
|
|
14
|
+
/** Currently active state */
|
|
15
|
+
activeState?: DataViewState | string;
|
|
16
|
+
}
|
|
17
|
+
/** extends InternalContextProps */
|
|
18
|
+
export interface InternalContextValue extends InternalContextProps {
|
|
19
|
+
/** Flag indicating if data view is selectable (auto-calculated) */
|
|
20
|
+
isSelectable: boolean;
|
|
21
|
+
}
|
|
22
|
+
export declare const InternalContext: React.Context<InternalContextValue>;
|
|
23
|
+
export type InternalProviderProps = PropsWithChildren<InternalContextProps>;
|
|
24
|
+
export declare const InternalContextProvider: React.FC<InternalProviderProps>;
|
|
25
|
+
export declare const useInternalContext: () => InternalContextValue;
|
|
26
|
+
export default InternalContext;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.useInternalContext = exports.InternalContextProvider = exports.InternalContext = void 0;
|
|
27
|
+
const react_1 = __importStar(require("react"));
|
|
28
|
+
exports.InternalContext = (0, react_1.createContext)({
|
|
29
|
+
selection: undefined,
|
|
30
|
+
activeState: undefined,
|
|
31
|
+
isSelectable: false,
|
|
32
|
+
});
|
|
33
|
+
const InternalContextProvider = ({ children, selection, activeState }) => {
|
|
34
|
+
const isSelectable = (0, react_1.useMemo)(() => Boolean((selection === null || selection === void 0 ? void 0 : selection.onSelect) && (selection === null || selection === void 0 ? void 0 : selection.isSelected)), [selection === null || selection === void 0 ? void 0 : selection.onSelect, selection === null || selection === void 0 ? void 0 : selection.isSelected]);
|
|
35
|
+
return (react_1.default.createElement(exports.InternalContext.Provider, { value: { selection, activeState, isSelectable } }, children));
|
|
36
|
+
};
|
|
37
|
+
exports.InternalContextProvider = InternalContextProvider;
|
|
38
|
+
const useInternalContext = () => (0, react_1.useContext)(exports.InternalContext);
|
|
39
|
+
exports.useInternalContext = useInternalContext;
|
|
40
|
+
exports.default = exports.InternalContext;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const react_1 = __importDefault(require("react"));
|
|
7
|
+
const react_2 = require("@testing-library/react");
|
|
8
|
+
require("@testing-library/jest-dom");
|
|
9
|
+
const InternalContext_1 = require("./InternalContext");
|
|
10
|
+
const DataView_1 = require("../DataView");
|
|
11
|
+
describe('InternalContext', () => {
|
|
12
|
+
const mockSelection = {
|
|
13
|
+
onSelect: jest.fn(),
|
|
14
|
+
isSelected: jest.fn(),
|
|
15
|
+
isSelectDisabled: jest.fn(),
|
|
16
|
+
};
|
|
17
|
+
test('should provide context value and allow consuming it', () => {
|
|
18
|
+
const TestComponent = () => {
|
|
19
|
+
const { selection } = (0, InternalContext_1.useInternalContext)();
|
|
20
|
+
return (react_1.default.createElement("div", null,
|
|
21
|
+
react_1.default.createElement("button", { onClick: () => selection === null || selection === void 0 ? void 0 : selection.onSelect(true, ['item1']) }, "Select item"),
|
|
22
|
+
react_1.default.createElement("span", null, (selection === null || selection === void 0 ? void 0 : selection.isSelected('item1')) ? 'Selected' : 'Not selected')));
|
|
23
|
+
};
|
|
24
|
+
const { getByText } = (0, react_2.render)(react_1.default.createElement(DataView_1.DataView, { selection: mockSelection },
|
|
25
|
+
react_1.default.createElement(TestComponent, null)));
|
|
26
|
+
react_2.fireEvent.click(getByText('Select item'));
|
|
27
|
+
expect(mockSelection.onSelect).toHaveBeenCalledWith(true, ['item1']);
|
|
28
|
+
});
|
|
29
|
+
test('should handle selection state correctly', () => {
|
|
30
|
+
const mockSelectionState = Object.assign(Object.assign({}, mockSelection), { isSelected: jest.fn((item) => item === 'item1') });
|
|
31
|
+
const TestComponent = () => {
|
|
32
|
+
const { selection } = (0, InternalContext_1.useInternalContext)();
|
|
33
|
+
return (react_1.default.createElement("div", null,
|
|
34
|
+
react_1.default.createElement("span", null, (selection === null || selection === void 0 ? void 0 : selection.isSelected('item1')) ? 'Item 1 is selected' : 'Item 1 is not selected'),
|
|
35
|
+
react_1.default.createElement("span", null, (selection === null || selection === void 0 ? void 0 : selection.isSelected('item2')) ? 'Item 2 is selected' : 'Item 2 is not selected')));
|
|
36
|
+
};
|
|
37
|
+
const { getByText } = (0, react_2.render)(react_1.default.createElement(DataView_1.DataView, { selection: mockSelectionState },
|
|
38
|
+
react_1.default.createElement(TestComponent, null)));
|
|
39
|
+
expect(getByText('Item 1 is selected')).toBeInTheDocument();
|
|
40
|
+
expect(getByText('Item 2 is not selected')).toBeInTheDocument();
|
|
41
|
+
});
|
|
42
|
+
test('should handle selection disabled correctly', () => {
|
|
43
|
+
const mockSelectionWithDisabled = Object.assign(Object.assign({}, mockSelection), { isSelectDisabled: jest.fn((item) => item === 'item3') });
|
|
44
|
+
const TestComponent = () => {
|
|
45
|
+
var _a, _b;
|
|
46
|
+
const { selection } = (0, InternalContext_1.useInternalContext)();
|
|
47
|
+
return (react_1.default.createElement("div", null,
|
|
48
|
+
react_1.default.createElement("span", null, ((_a = selection === null || selection === void 0 ? void 0 : selection.isSelectDisabled) === null || _a === void 0 ? void 0 : _a.call(selection, 'item3')) ? 'Item 3 is disabled' : 'Item 3 is enabled'),
|
|
49
|
+
react_1.default.createElement("span", null, ((_b = selection === null || selection === void 0 ? void 0 : selection.isSelectDisabled) === null || _b === void 0 ? void 0 : _b.call(selection, 'item1')) ? 'Item 1 is disabled' : 'Item 1 is enabled')));
|
|
50
|
+
};
|
|
51
|
+
const { getByText } = (0, react_2.render)(react_1.default.createElement(DataView_1.DataView, { selection: mockSelectionWithDisabled },
|
|
52
|
+
react_1.default.createElement(TestComponent, null)));
|
|
53
|
+
expect(getByText('Item 3 is disabled')).toBeInTheDocument();
|
|
54
|
+
expect(getByText('Item 1 is enabled')).toBeInTheDocument();
|
|
55
|
+
});
|
|
56
|
+
});
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
17
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
18
|
+
};
|
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
+
exports.default = void 0;
|
|
21
|
+
var InternalContext_1 = require("./InternalContext");
|
|
22
|
+
Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(InternalContext_1).default; } });
|
|
23
|
+
__exportStar(require("./InternalContext"), exports);
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
|
+
export { default as InternalContext } from './InternalContext';
|
|
2
|
+
export * from './InternalContext';
|
|
1
3
|
export * from './Hooks';
|
|
2
4
|
export { default as DataViewToolbar } from './DataViewToolbar';
|
|
3
5
|
export * from './DataViewToolbar';
|
|
6
|
+
export { default as DataViewTextFilter } from './DataViewTextFilter';
|
|
7
|
+
export * from './DataViewTextFilter';
|
|
8
|
+
export { default as DataViewTableTree } from './DataViewTableTree';
|
|
9
|
+
export * from './DataViewTableTree';
|
|
10
|
+
export { default as DataViewTableHead } from './DataViewTableHead';
|
|
11
|
+
export * from './DataViewTableHead';
|
|
12
|
+
export { default as DataViewTableBasic } from './DataViewTableBasic';
|
|
13
|
+
export * from './DataViewTableBasic';
|
|
14
|
+
export { default as DataViewTable } from './DataViewTable';
|
|
15
|
+
export * from './DataViewTable';
|
|
16
|
+
export { default as DataViewEventsContext } from './DataViewEventsContext';
|
|
17
|
+
export * from './DataViewEventsContext';
|
|
18
|
+
export { default as DataViewCheckboxFilter } from './DataViewCheckboxFilter';
|
|
19
|
+
export * from './DataViewCheckboxFilter';
|
|
4
20
|
export { default as DataView } from './DataView';
|
|
5
21
|
export * from './DataView';
|
package/dist/cjs/index.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
// this file is autogenerated by generate-index.js, modifying it manually will have no effect
|
|
2
3
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
4
|
if (k2 === undefined) k2 = k;
|
|
4
5
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
@@ -17,12 +18,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
17
18
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
18
19
|
};
|
|
19
20
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
-
exports.DataView = exports.DataViewToolbar = void 0;
|
|
21
|
-
|
|
21
|
+
exports.DataView = exports.DataViewCheckboxFilter = exports.DataViewEventsContext = exports.DataViewTable = exports.DataViewTableBasic = exports.DataViewTableHead = exports.DataViewTableTree = exports.DataViewTextFilter = exports.DataViewToolbar = exports.InternalContext = void 0;
|
|
22
|
+
var InternalContext_1 = require("./InternalContext");
|
|
23
|
+
Object.defineProperty(exports, "InternalContext", { enumerable: true, get: function () { return __importDefault(InternalContext_1).default; } });
|
|
24
|
+
__exportStar(require("./InternalContext"), exports);
|
|
22
25
|
__exportStar(require("./Hooks"), exports);
|
|
23
26
|
var DataViewToolbar_1 = require("./DataViewToolbar");
|
|
24
27
|
Object.defineProperty(exports, "DataViewToolbar", { enumerable: true, get: function () { return __importDefault(DataViewToolbar_1).default; } });
|
|
25
28
|
__exportStar(require("./DataViewToolbar"), exports);
|
|
29
|
+
var DataViewTextFilter_1 = require("./DataViewTextFilter");
|
|
30
|
+
Object.defineProperty(exports, "DataViewTextFilter", { enumerable: true, get: function () { return __importDefault(DataViewTextFilter_1).default; } });
|
|
31
|
+
__exportStar(require("./DataViewTextFilter"), exports);
|
|
32
|
+
var DataViewTableTree_1 = require("./DataViewTableTree");
|
|
33
|
+
Object.defineProperty(exports, "DataViewTableTree", { enumerable: true, get: function () { return __importDefault(DataViewTableTree_1).default; } });
|
|
34
|
+
__exportStar(require("./DataViewTableTree"), exports);
|
|
35
|
+
var DataViewTableHead_1 = require("./DataViewTableHead");
|
|
36
|
+
Object.defineProperty(exports, "DataViewTableHead", { enumerable: true, get: function () { return __importDefault(DataViewTableHead_1).default; } });
|
|
37
|
+
__exportStar(require("./DataViewTableHead"), exports);
|
|
38
|
+
var DataViewTableBasic_1 = require("./DataViewTableBasic");
|
|
39
|
+
Object.defineProperty(exports, "DataViewTableBasic", { enumerable: true, get: function () { return __importDefault(DataViewTableBasic_1).default; } });
|
|
40
|
+
__exportStar(require("./DataViewTableBasic"), exports);
|
|
41
|
+
var DataViewTable_1 = require("./DataViewTable");
|
|
42
|
+
Object.defineProperty(exports, "DataViewTable", { enumerable: true, get: function () { return __importDefault(DataViewTable_1).default; } });
|
|
43
|
+
__exportStar(require("./DataViewTable"), exports);
|
|
44
|
+
var DataViewEventsContext_1 = require("./DataViewEventsContext");
|
|
45
|
+
Object.defineProperty(exports, "DataViewEventsContext", { enumerable: true, get: function () { return __importDefault(DataViewEventsContext_1).default; } });
|
|
46
|
+
__exportStar(require("./DataViewEventsContext"), exports);
|
|
47
|
+
var DataViewCheckboxFilter_1 = require("./DataViewCheckboxFilter");
|
|
48
|
+
Object.defineProperty(exports, "DataViewCheckboxFilter", { enumerable: true, get: function () { return __importDefault(DataViewCheckboxFilter_1).default; } });
|
|
49
|
+
__exportStar(require("./DataViewCheckboxFilter"), exports);
|
|
26
50
|
var DataView_1 = require("./DataView");
|
|
27
51
|
Object.defineProperty(exports, "DataView", { enumerable: true, get: function () { return __importDefault(DataView_1).default; } });
|
|
28
52
|
__exportStar(require("./DataView"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewCheckboxFilter/index.js","module":"../../esm/DataViewCheckboxFilter/index.js","typings":"../../esm/DataViewCheckboxFilter/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewEventsContext/index.js","module":"../../esm/DataViewEventsContext/index.js","typings":"../../esm/DataViewEventsContext/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewFilters/index.js","module":"../../esm/DataViewFilters/index.js","typings":"../../esm/DataViewFilters/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewTable/index.js","module":"../../esm/DataViewTable/index.js","typings":"../../esm/DataViewTable/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewTableBasic/index.js","module":"../../esm/DataViewTableBasic/index.js","typings":"../../esm/DataViewTableBasic/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewTableHead/index.js","module":"../../esm/DataViewTableHead/index.js","typings":"../../esm/DataViewTableHead/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewTableTree/index.js","module":"../../esm/DataViewTableTree/index.js","typings":"../../esm/DataViewTableTree/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/DataViewTextFilter/index.js","module":"../../esm/DataViewTextFilter/index.js","typings":"../../esm/DataViewTextFilter/index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"main":"../../cjs/InternalContext/index.js","module":"../../esm/InternalContext/index.js","typings":"../../esm/InternalContext/index.d.ts"}
|
|
@@ -1,9 +1,23 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
-
|
|
2
|
+
import { StackProps } from '@patternfly/react-core';
|
|
3
|
+
import { DataViewSelection } from '../InternalContext';
|
|
4
|
+
export declare const DataViewState: {
|
|
5
|
+
readonly empty: "empty";
|
|
6
|
+
readonly loading: "loading";
|
|
7
|
+
readonly error: "error";
|
|
8
|
+
};
|
|
9
|
+
export type DataViewState = typeof DataViewState[keyof typeof DataViewState];
|
|
10
|
+
/** extends StackProps */
|
|
11
|
+
export interface DataViewProps extends StackProps {
|
|
3
12
|
/** Content rendered inside the data view */
|
|
4
13
|
children: React.ReactNode;
|
|
5
14
|
/** Custom OUIA ID */
|
|
6
15
|
ouiaId?: string;
|
|
16
|
+
/** Selection context configuration */
|
|
17
|
+
selection?: DataViewSelection;
|
|
18
|
+
/** Currently active state */
|
|
19
|
+
activeState?: DataViewState | string;
|
|
7
20
|
}
|
|
21
|
+
export type DataViewImpementationProps = Omit<DataViewProps, 'onSelect' | 'isItemSelected' | 'isItemSelectDisabled'>;
|
|
8
22
|
export declare const DataView: React.FC<DataViewProps>;
|
|
9
23
|
export default DataView;
|
|
@@ -11,8 +11,19 @@ var __rest = (this && this.__rest) || function (s, e) {
|
|
|
11
11
|
};
|
|
12
12
|
import React from 'react';
|
|
13
13
|
import { Stack, StackItem } from '@patternfly/react-core';
|
|
14
|
-
|
|
14
|
+
import { InternalContextProvider } from '../InternalContext';
|
|
15
|
+
export const DataViewState = {
|
|
16
|
+
empty: 'empty',
|
|
17
|
+
loading: 'loading',
|
|
18
|
+
error: 'error'
|
|
19
|
+
};
|
|
20
|
+
const DataViewImplementation = (_a) => {
|
|
15
21
|
var { children, ouiaId = 'DataView' } = _a, props = __rest(_a, ["children", "ouiaId"]);
|
|
16
|
-
return (React.createElement(Stack, Object.assign({ "data-ouia-component-id": `${ouiaId}-stack
|
|
22
|
+
return (React.createElement(Stack, Object.assign({ "data-ouia-component-id": `${ouiaId}-stack` }, props), React.Children.map(children, (child, index) => (React.createElement(StackItem, { "data-ouia-component-id": `${ouiaId}-stack-item-${index}` }, child)))));
|
|
23
|
+
};
|
|
24
|
+
export const DataView = (_a) => {
|
|
25
|
+
var { children, selection, activeState } = _a, props = __rest(_a, ["children", "selection", "activeState"]);
|
|
26
|
+
return (React.createElement(InternalContextProvider, { selection: selection, activeState: activeState },
|
|
27
|
+
React.createElement(DataViewImplementation, Object.assign({}, props), children)));
|
|
17
28
|
};
|
|
18
29
|
export default DataView;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { MenuProps } from '@patternfly/react-core';
|
|
3
|
+
import { DataViewFilterOption } from '../DataViewFilters';
|
|
4
|
+
export declare const isDataViewFilterOption: (obj: unknown) => obj is DataViewFilterOption;
|
|
5
|
+
/** extends MenuProps */
|
|
6
|
+
export interface DataViewCheckboxFilterProps extends Omit<MenuProps, 'onSelect' | 'onChange'> {
|
|
7
|
+
/** Unique key for the filter attribute */
|
|
8
|
+
filterId: string;
|
|
9
|
+
/** Array of current filter values */
|
|
10
|
+
value?: string[];
|
|
11
|
+
/** Filter title displayed in the toolbar */
|
|
12
|
+
title: string;
|
|
13
|
+
/** Placeholder text of the menu */
|
|
14
|
+
placeholder?: string;
|
|
15
|
+
/** Filter options displayed */
|
|
16
|
+
options: (DataViewFilterOption | string)[];
|
|
17
|
+
/** Callback for updating when item selection changes. */
|
|
18
|
+
onChange?: (event?: React.MouseEvent, values?: string[]) => void;
|
|
19
|
+
/** Controls visibility of the filter in the toolbar */
|
|
20
|
+
showToolbarItem?: boolean;
|
|
21
|
+
/** Controls visibility of the filter icon */
|
|
22
|
+
showIcon?: boolean;
|
|
23
|
+
/** Controls visibility of the selected items badge */
|
|
24
|
+
showBadge?: boolean;
|
|
25
|
+
/** Custom OUIA ID */
|
|
26
|
+
ouiaId?: string;
|
|
27
|
+
}
|
|
28
|
+
export declare const DataViewCheckboxFilter: React.FC<DataViewCheckboxFilterProps>;
|
|
29
|
+
export default DataViewCheckboxFilter;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
2
|
+
var t = {};
|
|
3
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
4
|
+
t[p] = s[p];
|
|
5
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
6
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
7
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
8
|
+
t[p[i]] = s[p[i]];
|
|
9
|
+
}
|
|
10
|
+
return t;
|
|
11
|
+
};
|
|
12
|
+
import React from 'react';
|
|
13
|
+
import { Badge, Menu, MenuContent, MenuItem, MenuList, MenuToggle, Popper, ToolbarFilter, } from '@patternfly/react-core';
|
|
14
|
+
import { FilterIcon } from '@patternfly/react-icons';
|
|
15
|
+
const isToolbarLabel = (label) => typeof label === 'object' && 'key' in label;
|
|
16
|
+
export const isDataViewFilterOption = (obj) => !!obj &&
|
|
17
|
+
typeof obj === 'object' &&
|
|
18
|
+
'label' in obj &&
|
|
19
|
+
'value' in obj &&
|
|
20
|
+
typeof obj.value === 'string';
|
|
21
|
+
export const DataViewCheckboxFilter = (_a) => {
|
|
22
|
+
var { filterId, title, value = [], onChange, placeholder, options = [], showToolbarItem, showIcon = !placeholder, showBadge = !placeholder, ouiaId = 'DataViewCheckboxFilter' } = _a, props = __rest(_a, ["filterId", "title", "value", "onChange", "placeholder", "options", "showToolbarItem", "showIcon", "showBadge", "ouiaId"]);
|
|
23
|
+
const [isOpen, setIsOpen] = React.useState(false);
|
|
24
|
+
const toggleRef = React.useRef(null);
|
|
25
|
+
const menuRef = React.useRef(null);
|
|
26
|
+
const containerRef = React.useRef(null);
|
|
27
|
+
const normalizeOptions = React.useMemo(() => options.map(option => typeof option === 'string'
|
|
28
|
+
? { label: option, value: option }
|
|
29
|
+
: option), [options]);
|
|
30
|
+
const handleToggleClick = (event) => {
|
|
31
|
+
event.stopPropagation();
|
|
32
|
+
setTimeout(() => {
|
|
33
|
+
var _a;
|
|
34
|
+
const firstElement = (_a = menuRef.current) === null || _a === void 0 ? void 0 : _a.querySelector('li > button:not(:disabled)');
|
|
35
|
+
firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus();
|
|
36
|
+
}, 0);
|
|
37
|
+
setIsOpen(prev => !prev);
|
|
38
|
+
};
|
|
39
|
+
const handleSelect = (event, itemId) => {
|
|
40
|
+
const activeItem = String(itemId);
|
|
41
|
+
const isSelected = value.includes(activeItem);
|
|
42
|
+
onChange === null || onChange === void 0 ? void 0 : onChange(event, isSelected ? value.filter(item => item !== activeItem) : [activeItem, ...value]);
|
|
43
|
+
};
|
|
44
|
+
const handleClickOutside = (event) => isOpen &&
|
|
45
|
+
menuRef.current && toggleRef.current &&
|
|
46
|
+
!menuRef.current.contains(event.target) && !toggleRef.current.contains(event.target)
|
|
47
|
+
&& setIsOpen(false);
|
|
48
|
+
React.useEffect(() => {
|
|
49
|
+
window.addEventListener('click', handleClickOutside);
|
|
50
|
+
return () => {
|
|
51
|
+
window.removeEventListener('click', handleClickOutside);
|
|
52
|
+
};
|
|
53
|
+
}, [isOpen]); // eslint-disable-line react-hooks/exhaustive-deps
|
|
54
|
+
return (React.createElement(ToolbarFilter, { key: ouiaId, "data-ouia-component-id": ouiaId, labels: value.map(item => {
|
|
55
|
+
const activeOption = normalizeOptions.find(option => option.value === item);
|
|
56
|
+
return ({ key: activeOption === null || activeOption === void 0 ? void 0 : activeOption.value, node: activeOption === null || activeOption === void 0 ? void 0 : activeOption.label });
|
|
57
|
+
}), deleteLabel: (_, label) => onChange === null || onChange === void 0 ? void 0 : onChange(undefined, value.filter(item => item !== (isToolbarLabel(label) ? label.key : label))), categoryName: title, showToolbarItem: showToolbarItem },
|
|
58
|
+
React.createElement(Popper, { trigger: React.createElement(MenuToggle, { ouiaId: `${ouiaId}-toggle`, ref: toggleRef, onClick: handleToggleClick, isExpanded: isOpen, icon: showIcon ? React.createElement(FilterIcon, null) : undefined, badge: value.length > 0 && showBadge ? React.createElement(Badge, { "data-ouia-component-id": `${ouiaId}-badge`, isRead: true }, value.length) : undefined, style: { width: '200px' } }, placeholder !== null && placeholder !== void 0 ? placeholder : title), triggerRef: toggleRef, popper: React.createElement(Menu, Object.assign({ ref: menuRef, ouiaId: `${ouiaId}-menu`, onSelect: handleSelect, selected: value }, props),
|
|
59
|
+
React.createElement(MenuContent, null,
|
|
60
|
+
React.createElement(MenuList, null, normalizeOptions.map(option => (React.createElement(MenuItem, { "data-ouia-component-id": `${ouiaId}-filter-item-${option.value}`, key: option.value, itemId: option.value, isSelected: value.includes(option.value), hasCheckbox: true }, option.label)))))), popperRef: menuRef, appendTo: containerRef.current || undefined, "aria-label": `${title !== null && title !== void 0 ? title : filterId} filter`, isVisible: isOpen })));
|
|
61
|
+
};
|
|
62
|
+
export default DataViewCheckboxFilter;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { render } from '@testing-library/react';
|
|
3
|
+
import DataViewCheckboxFilter from './DataViewCheckboxFilter';
|
|
4
|
+
import DataViewToolbar from '../DataViewToolbar';
|
|
5
|
+
describe('DataViewCheckboxFilter component', () => {
|
|
6
|
+
const defaultProps = {
|
|
7
|
+
filterId: 'test-checkbox-filter',
|
|
8
|
+
title: 'Test Checkbox Filter',
|
|
9
|
+
value: ['workspace-one'],
|
|
10
|
+
options: [
|
|
11
|
+
{ label: 'Workspace one', value: 'workspace-one' },
|
|
12
|
+
{ label: 'Workspace two', value: 'workspace-two' },
|
|
13
|
+
{ label: 'Workspace three', value: 'workspace-three' },
|
|
14
|
+
],
|
|
15
|
+
};
|
|
16
|
+
it('should render correctly', () => {
|
|
17
|
+
const { container } = render(React.createElement(DataViewToolbar, { filters: React.createElement(DataViewCheckboxFilter, Object.assign({}, defaultProps)) }));
|
|
18
|
+
expect(container).toMatchSnapshot();
|
|
19
|
+
});
|
|
20
|
+
});
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import React, { PropsWithChildren } from "react";
|
|
2
|
+
export declare const EventTypes: {
|
|
3
|
+
readonly rowClick: "rowClick";
|
|
4
|
+
};
|
|
5
|
+
export type DataViewEvent = typeof EventTypes[keyof typeof EventTypes];
|
|
6
|
+
type Callback = (...args: any[]) => void;
|
|
7
|
+
type Subscribe = (event: DataViewEvent, callback: Callback) => () => void;
|
|
8
|
+
type Trigger = (event: DataViewEvent, ...payload: any[]) => void;
|
|
9
|
+
export interface DataViewEventsContextValue {
|
|
10
|
+
subscribe: Subscribe;
|
|
11
|
+
trigger: Trigger;
|
|
12
|
+
}
|
|
13
|
+
export declare const DataViewEventsContext: React.Context<DataViewEventsContextValue>;
|
|
14
|
+
export declare const DataViewEventsProvider: ({ children }: PropsWithChildren) => React.JSX.Element;
|
|
15
|
+
export declare const useDataViewEventsContext: () => DataViewEventsContextValue;
|
|
16
|
+
export default DataViewEventsContext;
|