@patternfly/react-data-view 5.0.1 → 5.1.1
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 +4 -0
- package/dist/cjs/DataView/DataView.js +7 -1
- 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/DataViewTable/DataViewTable.d.ts +37 -0
- package/dist/cjs/DataViewTable/DataViewTable.js +59 -0
- package/dist/cjs/DataViewTable/DataViewTable.test.d.ts +1 -0
- package/dist/cjs/DataViewTable/DataViewTable.test.js +27 -0
- package/dist/cjs/DataViewTable/index.d.ts +2 -0
- package/dist/cjs/DataViewTable/index.js +23 -0
- package/dist/cjs/Hooks/pagination.d.ts +13 -1
- package/dist/cjs/Hooks/pagination.js +36 -4
- package/dist/cjs/Hooks/pagination.test.js +53 -1
- package/dist/cjs/Hooks/selection.d.ts +3 -3
- package/dist/cjs/Hooks/selection.js +4 -6
- package/dist/cjs/Hooks/selection.test.js +4 -4
- package/dist/cjs/InternalContext/InternalContext.d.ts +17 -0
- package/dist/cjs/InternalContext/InternalContext.js +35 -0
- package/dist/cjs/InternalContext/InternalContext.test.d.ts +1 -0
- package/dist/cjs/InternalContext/InternalContext.test.js +55 -0
- package/dist/cjs/InternalContext/index.d.ts +2 -0
- package/dist/cjs/InternalContext/index.js +23 -0
- package/dist/cjs/index.d.ts +6 -0
- package/dist/cjs/index.js +11 -2
- package/dist/dynamic/DataViewEventsContext/package.json +1 -0
- package/dist/dynamic/DataViewTable/package.json +1 -0
- package/dist/dynamic/InternalContext/package.json +1 -0
- package/dist/esm/DataView/DataView.d.ts +4 -0
- package/dist/esm/DataView/DataView.js +7 -1
- 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/DataViewTable/DataViewTable.d.ts +37 -0
- package/dist/esm/DataViewTable/DataViewTable.js +49 -0
- package/dist/esm/DataViewTable/DataViewTable.test.d.ts +1 -0
- package/dist/esm/DataViewTable/DataViewTable.test.js +22 -0
- package/dist/esm/DataViewTable/index.d.ts +2 -0
- package/dist/esm/DataViewTable/index.js +2 -0
- package/dist/esm/Hooks/pagination.d.ts +13 -1
- package/dist/esm/Hooks/pagination.js +36 -4
- package/dist/esm/Hooks/pagination.test.js +53 -1
- package/dist/esm/Hooks/selection.d.ts +3 -3
- package/dist/esm/Hooks/selection.js +4 -6
- package/dist/esm/Hooks/selection.test.js +4 -4
- package/dist/esm/InternalContext/InternalContext.d.ts +17 -0
- package/dist/esm/InternalContext/InternalContext.js +7 -0
- package/dist/esm/InternalContext/InternalContext.test.d.ts +1 -0
- package/dist/esm/InternalContext/InternalContext.test.js +50 -0
- package/dist/esm/InternalContext/index.d.ts +2 -0
- package/dist/esm/InternalContext/index.js +2 -0
- package/dist/esm/index.d.ts +6 -0
- package/dist/esm/index.js +6 -0
- package/package.json +1 -1
- package/patternfly-docs/content/extensions/data-view/examples/Components/Components.md +33 -3
- package/patternfly-docs/content/extensions/data-view/examples/Components/DataViewTableExample.tsx +47 -0
- package/patternfly-docs/content/extensions/data-view/examples/EventsContext/EventsContext.md +32 -0
- package/patternfly-docs/content/extensions/data-view/examples/EventsContext/EventsExample.tsx +108 -0
- package/patternfly-docs/content/extensions/data-view/examples/Functionality/Functionality.md +15 -5
- package/patternfly-docs/content/extensions/data-view/examples/Functionality/PaginationExample.tsx +20 -29
- package/patternfly-docs/content/extensions/data-view/examples/Functionality/SelectionExample.tsx +9 -40
- package/patternfly-docs/content/extensions/data-view/examples/Layout/Layout.md +1 -0
- package/patternfly-docs/content/extensions/data-view/examples/Layout/PredefinedLayoutExample.tsx +14 -45
- package/src/DataView/DataView.tsx +14 -2
- package/src/DataViewEventsContext/DataViewEventsContext.test.tsx +105 -0
- package/src/DataViewEventsContext/DataViewEventsContext.tsx +70 -0
- package/src/DataViewEventsContext/index.ts +2 -0
- package/src/DataViewTable/DataViewTable.test.tsx +37 -0
- package/src/DataViewTable/DataViewTable.tsx +96 -0
- package/src/DataViewTable/__snapshots__/DataViewTable.test.tsx.snap +320 -0
- package/src/DataViewTable/index.ts +2 -0
- package/src/Hooks/pagination.test.tsx +81 -1
- package/src/Hooks/pagination.ts +71 -15
- package/src/Hooks/selection.test.tsx +5 -5
- package/src/Hooks/selection.ts +6 -7
- package/src/InternalContext/InternalContext.test.tsx +88 -0
- package/src/InternalContext/InternalContext.tsx +35 -0
- package/src/InternalContext/index.ts +2 -0
- package/src/index.ts +9 -0
|
@@ -0,0 +1,35 @@
|
|
|
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
|
+
});
|
|
31
|
+
const InternalContextProvider = ({ children, selection }) => (react_1.default.createElement(exports.InternalContext.Provider, { value: { selection } }, children));
|
|
32
|
+
exports.InternalContextProvider = InternalContextProvider;
|
|
33
|
+
const useInternalContext = () => (0, react_1.useContext)(exports.InternalContext);
|
|
34
|
+
exports.useInternalContext = useInternalContext;
|
|
35
|
+
exports.default = exports.InternalContext;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|
|
@@ -0,0 +1,55 @@
|
|
|
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
|
+
describe('InternalContext', () => {
|
|
11
|
+
const mockSelection = {
|
|
12
|
+
onSelect: jest.fn(),
|
|
13
|
+
isSelected: jest.fn(),
|
|
14
|
+
isSelectDisabled: jest.fn(),
|
|
15
|
+
};
|
|
16
|
+
test('should provide context value and allow consuming it', () => {
|
|
17
|
+
const TestComponent = () => {
|
|
18
|
+
const { selection } = (0, InternalContext_1.useInternalContext)();
|
|
19
|
+
return (react_1.default.createElement("div", null,
|
|
20
|
+
react_1.default.createElement("button", { onClick: () => selection === null || selection === void 0 ? void 0 : selection.onSelect(true, ['item1']) }, "Select item"),
|
|
21
|
+
react_1.default.createElement("span", null, (selection === null || selection === void 0 ? void 0 : selection.isSelected('item1')) ? 'Selected' : 'Not selected')));
|
|
22
|
+
};
|
|
23
|
+
const { getByText } = (0, react_2.render)(react_1.default.createElement(InternalContext_1.InternalContextProvider, { selection: mockSelection },
|
|
24
|
+
react_1.default.createElement(TestComponent, null)));
|
|
25
|
+
react_2.fireEvent.click(getByText('Select item'));
|
|
26
|
+
expect(mockSelection.onSelect).toHaveBeenCalledWith(true, ['item1']);
|
|
27
|
+
});
|
|
28
|
+
test('should handle selection state correctly', () => {
|
|
29
|
+
const mockSelectionState = Object.assign(Object.assign({}, mockSelection), { isSelected: jest.fn((item) => item === 'item1') });
|
|
30
|
+
const TestComponent = () => {
|
|
31
|
+
const { selection } = (0, InternalContext_1.useInternalContext)();
|
|
32
|
+
return (react_1.default.createElement("div", null,
|
|
33
|
+
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'),
|
|
34
|
+
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')));
|
|
35
|
+
};
|
|
36
|
+
const { getByText } = (0, react_2.render)(react_1.default.createElement(InternalContext_1.InternalContextProvider, { selection: mockSelectionState },
|
|
37
|
+
react_1.default.createElement(TestComponent, null)));
|
|
38
|
+
expect(getByText('Item 1 is selected')).toBeInTheDocument();
|
|
39
|
+
expect(getByText('Item 2 is not selected')).toBeInTheDocument();
|
|
40
|
+
});
|
|
41
|
+
test('should handle selection disabled correctly', () => {
|
|
42
|
+
const mockSelectionWithDisabled = Object.assign(Object.assign({}, mockSelection), { isSelectDisabled: jest.fn((item) => item === 'item3') });
|
|
43
|
+
const TestComponent = () => {
|
|
44
|
+
var _a, _b;
|
|
45
|
+
const { selection } = (0, InternalContext_1.useInternalContext)();
|
|
46
|
+
return (react_1.default.createElement("div", null,
|
|
47
|
+
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'),
|
|
48
|
+
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')));
|
|
49
|
+
};
|
|
50
|
+
const { getByText } = (0, react_2.render)(react_1.default.createElement(InternalContext_1.InternalContextProvider, { selection: mockSelectionWithDisabled },
|
|
51
|
+
react_1.default.createElement(TestComponent, null)));
|
|
52
|
+
expect(getByText('Item 3 is disabled')).toBeInTheDocument();
|
|
53
|
+
expect(getByText('Item 1 is enabled')).toBeInTheDocument();
|
|
54
|
+
});
|
|
55
|
+
});
|
|
@@ -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,11 @@
|
|
|
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 DataViewTable } from './DataViewTable';
|
|
7
|
+
export * from './DataViewTable';
|
|
8
|
+
export { default as DataViewEventsContext } from './DataViewEventsContext';
|
|
9
|
+
export * from './DataViewEventsContext';
|
|
4
10
|
export { default as DataView } from './DataView';
|
|
5
11
|
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,20 @@ 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.DataViewEventsContext = exports.DataViewTable = 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 DataViewTable_1 = require("./DataViewTable");
|
|
30
|
+
Object.defineProperty(exports, "DataViewTable", { enumerable: true, get: function () { return __importDefault(DataViewTable_1).default; } });
|
|
31
|
+
__exportStar(require("./DataViewTable"), exports);
|
|
32
|
+
var DataViewEventsContext_1 = require("./DataViewEventsContext");
|
|
33
|
+
Object.defineProperty(exports, "DataViewEventsContext", { enumerable: true, get: function () { return __importDefault(DataViewEventsContext_1).default; } });
|
|
34
|
+
__exportStar(require("./DataViewEventsContext"), exports);
|
|
26
35
|
var DataView_1 = require("./DataView");
|
|
27
36
|
Object.defineProperty(exports, "DataView", { enumerable: true, get: function () { return __importDefault(DataView_1).default; } });
|
|
28
37
|
__exportStar(require("./DataView"), exports);
|
|
@@ -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/DataViewTable/index.js","module":"../../esm/DataViewTable/index.js","typings":"../../esm/DataViewTable/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,13 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
+
import { DataViewSelection } from '../InternalContext';
|
|
2
3
|
export interface DataViewProps {
|
|
3
4
|
/** Content rendered inside the data view */
|
|
4
5
|
children: React.ReactNode;
|
|
5
6
|
/** Custom OUIA ID */
|
|
6
7
|
ouiaId?: string;
|
|
8
|
+
/** Selection context configuration */
|
|
9
|
+
selection?: DataViewSelection;
|
|
7
10
|
}
|
|
11
|
+
export type DataViewImpementationProps = Omit<DataViewProps, 'onSelect' | 'isItemSelected' | 'isItemSelectDisabled'>;
|
|
8
12
|
export declare const DataView: React.FC<DataViewProps>;
|
|
9
13
|
export default DataView;
|
|
@@ -11,8 +11,14 @@ 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
|
+
const DataViewImplementation = (_a) => {
|
|
15
16
|
var { children, ouiaId = 'DataView' } = _a, props = __rest(_a, ["children", "ouiaId"]);
|
|
16
17
|
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)))));
|
|
17
18
|
};
|
|
19
|
+
export const DataView = (_a) => {
|
|
20
|
+
var { children, selection } = _a, props = __rest(_a, ["children", "selection"]);
|
|
21
|
+
return (React.createElement(InternalContextProvider, { selection: selection },
|
|
22
|
+
React.createElement(DataViewImplementation, Object.assign({}, props), children)));
|
|
23
|
+
};
|
|
18
24
|
export default DataView;
|
|
@@ -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;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import React, { createContext, useCallback, useContext, useState } from "react";
|
|
2
|
+
export const EventTypes = {
|
|
3
|
+
rowClick: 'rowClick'
|
|
4
|
+
};
|
|
5
|
+
export const DataViewEventsContext = createContext({
|
|
6
|
+
subscribe: () => () => null,
|
|
7
|
+
trigger: () => null
|
|
8
|
+
});
|
|
9
|
+
export const DataViewEventsProvider = ({ children }) => {
|
|
10
|
+
const [subscriptions, setSubscriptions] = useState({
|
|
11
|
+
[EventTypes.rowClick]: {}
|
|
12
|
+
});
|
|
13
|
+
const subscribe = (event, callback) => {
|
|
14
|
+
const id = crypto.randomUUID();
|
|
15
|
+
// set new subscription
|
|
16
|
+
setSubscriptions(prevSubscriptions => (Object.assign(Object.assign({}, prevSubscriptions), { [event]: Object.assign(Object.assign({}, prevSubscriptions[event]), { [id]: callback }) })));
|
|
17
|
+
// return unsubscribe function
|
|
18
|
+
return () => {
|
|
19
|
+
setSubscriptions(prevSubscriptions => {
|
|
20
|
+
const updatedSubscriptions = Object.assign({}, prevSubscriptions);
|
|
21
|
+
delete updatedSubscriptions[event][id];
|
|
22
|
+
return updatedSubscriptions;
|
|
23
|
+
});
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
const trigger = useCallback((event, ...payload) => {
|
|
27
|
+
Object.values(subscriptions[event]).forEach(callback => {
|
|
28
|
+
callback(...payload);
|
|
29
|
+
});
|
|
30
|
+
}, [subscriptions]);
|
|
31
|
+
return (React.createElement(DataViewEventsContext.Provider, { value: { subscribe, trigger } }, children));
|
|
32
|
+
};
|
|
33
|
+
export const useDataViewEventsContext = () => useContext(DataViewEventsContext);
|
|
34
|
+
export default DataViewEventsContext;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { render, fireEvent } from '@testing-library/react';
|
|
3
|
+
import { useDataViewEventsContext, DataViewEventsProvider, EventTypes } from './DataViewEventsContext';
|
|
4
|
+
let id = 0;
|
|
5
|
+
beforeAll(() => {
|
|
6
|
+
Object.defineProperty(global, 'crypto', {
|
|
7
|
+
value: {
|
|
8
|
+
randomUUID: jest.fn(() => `mocked-uuid-${id++}`),
|
|
9
|
+
},
|
|
10
|
+
});
|
|
11
|
+
});
|
|
12
|
+
describe('DataViewEventsContext', () => {
|
|
13
|
+
test('should provide context value and allow subscriptions', () => {
|
|
14
|
+
const callback = jest.fn();
|
|
15
|
+
const TestComponent = () => {
|
|
16
|
+
const { subscribe, trigger } = useDataViewEventsContext();
|
|
17
|
+
React.useEffect(() => {
|
|
18
|
+
const unsubscribe = subscribe(EventTypes.rowClick, callback);
|
|
19
|
+
return () => unsubscribe();
|
|
20
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
21
|
+
}, []);
|
|
22
|
+
return (React.createElement("button", { onClick: () => trigger(EventTypes.rowClick, 'some payload') }, "Trigger"));
|
|
23
|
+
};
|
|
24
|
+
const { getByText } = render(React.createElement(DataViewEventsProvider, null,
|
|
25
|
+
React.createElement(TestComponent, null)));
|
|
26
|
+
fireEvent.click(getByText('Trigger'));
|
|
27
|
+
expect(callback).toHaveBeenCalledWith('some payload');
|
|
28
|
+
});
|
|
29
|
+
test('should handle unsubscribing correctly', () => {
|
|
30
|
+
const callback = jest.fn();
|
|
31
|
+
const TestComponent = () => {
|
|
32
|
+
const { subscribe, trigger } = useDataViewEventsContext();
|
|
33
|
+
React.useEffect(() => {
|
|
34
|
+
const unsubscribe = subscribe(EventTypes.rowClick, callback);
|
|
35
|
+
unsubscribe();
|
|
36
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
37
|
+
}, []);
|
|
38
|
+
return (React.createElement("button", { onClick: () => trigger(EventTypes.rowClick, 'some payload') }, "Trigger"));
|
|
39
|
+
};
|
|
40
|
+
const { getByText } = render(React.createElement(DataViewEventsProvider, null,
|
|
41
|
+
React.createElement(TestComponent, null)));
|
|
42
|
+
fireEvent.click(getByText('Trigger'));
|
|
43
|
+
expect(callback).not.toHaveBeenCalled();
|
|
44
|
+
});
|
|
45
|
+
test('should handle multiple subscriptions and trigger events correctly', () => {
|
|
46
|
+
const callback1 = jest.fn();
|
|
47
|
+
const callback2 = jest.fn();
|
|
48
|
+
const TestComponent = () => {
|
|
49
|
+
const { subscribe, trigger } = useDataViewEventsContext();
|
|
50
|
+
React.useEffect(() => {
|
|
51
|
+
const unsubscribe1 = subscribe(EventTypes.rowClick, callback1);
|
|
52
|
+
const unsubscribe2 = subscribe(EventTypes.rowClick, callback2);
|
|
53
|
+
return () => {
|
|
54
|
+
unsubscribe1();
|
|
55
|
+
unsubscribe2();
|
|
56
|
+
};
|
|
57
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
58
|
+
}, []);
|
|
59
|
+
return (React.createElement("button", { onClick: () => trigger(EventTypes.rowClick, 'some payload') }, "Trigger"));
|
|
60
|
+
};
|
|
61
|
+
const { getByText } = render(React.createElement(DataViewEventsProvider, null,
|
|
62
|
+
React.createElement(TestComponent, null)));
|
|
63
|
+
fireEvent.click(getByText('Trigger'));
|
|
64
|
+
expect(callback1).toHaveBeenCalledWith('some payload');
|
|
65
|
+
expect(callback2).toHaveBeenCalledWith('some payload');
|
|
66
|
+
});
|
|
67
|
+
});
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import React, { ReactNode } from 'react';
|
|
2
|
+
import { TableProps, TdProps, ThProps, TrProps } from '@patternfly/react-table';
|
|
3
|
+
export type DataViewTh = ReactNode | {
|
|
4
|
+
cell: ReactNode;
|
|
5
|
+
props?: ThProps;
|
|
6
|
+
};
|
|
7
|
+
export type DataViewTd = ReactNode | {
|
|
8
|
+
cell: ReactNode;
|
|
9
|
+
props?: TdProps;
|
|
10
|
+
};
|
|
11
|
+
export type DataViewTr = DataViewTd[] | {
|
|
12
|
+
row: DataViewTd[];
|
|
13
|
+
id?: string;
|
|
14
|
+
props?: TrProps;
|
|
15
|
+
};
|
|
16
|
+
export declare const isDataViewThObject: (value: DataViewTh) => value is {
|
|
17
|
+
cell: ReactNode;
|
|
18
|
+
props?: ThProps | undefined;
|
|
19
|
+
};
|
|
20
|
+
export declare const isDataViewTdObject: (value: DataViewTd) => value is {
|
|
21
|
+
cell: ReactNode;
|
|
22
|
+
props?: TdProps | undefined;
|
|
23
|
+
};
|
|
24
|
+
export declare const isDataViewTrObject: (value: DataViewTr) => value is {
|
|
25
|
+
row: DataViewTd[];
|
|
26
|
+
id?: string | undefined;
|
|
27
|
+
};
|
|
28
|
+
export interface DataViewTableProps extends Omit<TableProps, 'onSelect' | 'rows'> {
|
|
29
|
+
/** Columns definition */
|
|
30
|
+
columns: DataViewTh[];
|
|
31
|
+
/** Current page rows */
|
|
32
|
+
rows: DataViewTr[];
|
|
33
|
+
/** Custom OUIA ID */
|
|
34
|
+
ouiaId?: string;
|
|
35
|
+
}
|
|
36
|
+
export declare const DataViewTable: React.FC<DataViewTableProps>;
|
|
37
|
+
export default DataViewTable;
|
|
@@ -0,0 +1,49 @@
|
|
|
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 { Table, Tbody, Td, Th, Thead, Tr } from '@patternfly/react-table';
|
|
14
|
+
import { useInternalContext } from '../InternalContext';
|
|
15
|
+
export const isDataViewThObject = (value) => value != null && typeof value === 'object' && 'cell' in value;
|
|
16
|
+
export const isDataViewTdObject = (value) => value != null && typeof value === 'object' && 'cell' in value;
|
|
17
|
+
export const isDataViewTrObject = (value) => value != null && typeof value === 'object' && 'row' in value;
|
|
18
|
+
export const DataViewTable = (_a) => {
|
|
19
|
+
var { columns, rows, ouiaId = 'DataViewTable' } = _a, props = __rest(_a, ["columns", "rows", "ouiaId"]);
|
|
20
|
+
const { selection } = useInternalContext();
|
|
21
|
+
const { onSelect, isSelected, isSelectDisabled } = selection !== null && selection !== void 0 ? selection : {};
|
|
22
|
+
return (React.createElement(Table, Object.assign({ "aria-label": "Data table", ouiaId: ouiaId }, props),
|
|
23
|
+
React.createElement(Thead, { "data-ouia-component-id": `${ouiaId}-thead` },
|
|
24
|
+
React.createElement(Tr, { ouiaId: `${ouiaId}-tr-head` },
|
|
25
|
+
onSelect && isSelected && React.createElement(Th, { key: "row-select" }),
|
|
26
|
+
columns.map((column, index) => {
|
|
27
|
+
var _a;
|
|
28
|
+
return (React.createElement(Th, Object.assign({ key: index }, (isDataViewThObject(column) && ((_a = column === null || column === void 0 ? void 0 : column.props) !== null && _a !== void 0 ? _a : {})), { "data-ouia-component-id": `${ouiaId}-th-${index}` }), isDataViewThObject(column) ? column.cell : column));
|
|
29
|
+
}))),
|
|
30
|
+
React.createElement(Tbody, null, rows.map((row, rowIndex) => {
|
|
31
|
+
var _a;
|
|
32
|
+
const rowIsObject = isDataViewTrObject(row);
|
|
33
|
+
return (React.createElement(Tr, Object.assign({ key: rowIndex, ouiaId: `${ouiaId}-tr-${rowIndex}` }, (rowIsObject && ((_a = row === null || row === void 0 ? void 0 : row.props) !== null && _a !== void 0 ? _a : {}))),
|
|
34
|
+
onSelect && isSelected && (React.createElement(Td, { key: `select-${rowIndex}`, select: {
|
|
35
|
+
rowIndex,
|
|
36
|
+
onSelect: (_event, isSelecting) => {
|
|
37
|
+
onSelect === null || onSelect === void 0 ? void 0 : onSelect(isSelecting, rowIsObject ? row : [row]);
|
|
38
|
+
},
|
|
39
|
+
isSelected: (isSelected === null || isSelected === void 0 ? void 0 : isSelected(row)) || false,
|
|
40
|
+
isDisabled: (isSelectDisabled === null || isSelectDisabled === void 0 ? void 0 : isSelectDisabled(row)) || false,
|
|
41
|
+
} })),
|
|
42
|
+
(rowIsObject ? row.row : row).map((cell, colIndex) => {
|
|
43
|
+
var _a;
|
|
44
|
+
const cellIsObject = isDataViewTdObject(cell);
|
|
45
|
+
return (React.createElement(Td, Object.assign({ key: colIndex }, (cellIsObject && ((_a = cell === null || cell === void 0 ? void 0 : cell.props) !== null && _a !== void 0 ? _a : {})), { "data-ouia-component-id": `${ouiaId}-td-${rowIndex}-${colIndex}` }), cellIsObject ? cell.cell : cell));
|
|
46
|
+
})));
|
|
47
|
+
}))));
|
|
48
|
+
};
|
|
49
|
+
export default DataViewTable;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { render } from '@testing-library/react';
|
|
3
|
+
import { DataViewTable } from './DataViewTable';
|
|
4
|
+
const repositories = [
|
|
5
|
+
{ name: 'one', branches: 'two', prs: 'three', workspaces: 'four', lastCommit: 'five' },
|
|
6
|
+
{ name: 'one - 2', branches: null, prs: null, workspaces: 'four - 2', lastCommit: 'five - 2' },
|
|
7
|
+
{ name: 'one - 3', branches: 'two - 3', prs: 'three - 3', workspaces: 'four - 3', lastCommit: 'five - 3' },
|
|
8
|
+
{ name: 'one - 4', branches: 'two - 4', prs: 'null', workspaces: 'four - 4', lastCommit: 'five - 4' },
|
|
9
|
+
{ name: 'one - 5', branches: 'two - 5', prs: 'three - 5', workspaces: 'four - 5', lastCommit: 'five - 5' },
|
|
10
|
+
{ name: 'one - 6', branches: 'two - 6', prs: 'three - 6', workspaces: 'four - 6', lastCommit: 'five - 6' }
|
|
11
|
+
];
|
|
12
|
+
const rows = repositories.map(repo => ({
|
|
13
|
+
row: Object.values(repo),
|
|
14
|
+
}));
|
|
15
|
+
const columns = ['Repositories', 'Branches', 'Pull requests', 'Workspaces', 'Last commit'];
|
|
16
|
+
const ouiaId = 'TableExample';
|
|
17
|
+
describe('DataViewTable component', () => {
|
|
18
|
+
test('should render correctly', () => {
|
|
19
|
+
const { container } = render(React.createElement(DataViewTable, { "aria-label": 'Repositories table', ouiaId: ouiaId, columns: columns, rows: rows }));
|
|
20
|
+
expect(container).toMatchSnapshot();
|
|
21
|
+
});
|
|
22
|
+
});
|
|
@@ -1,14 +1,26 @@
|
|
|
1
|
+
export declare enum PaginationParams {
|
|
2
|
+
PAGE = "page",
|
|
3
|
+
PER_PAGE = "perPage"
|
|
4
|
+
}
|
|
1
5
|
export interface UseDataViewPaginationProps {
|
|
2
6
|
/** Initial page */
|
|
3
7
|
page?: number;
|
|
4
8
|
/** Items per page */
|
|
5
9
|
perPage: number;
|
|
10
|
+
/** Current search parameters as a string */
|
|
11
|
+
searchParams?: URLSearchParams;
|
|
12
|
+
/** Function to set search parameters */
|
|
13
|
+
setSearchParams?: (params: URLSearchParams) => void;
|
|
14
|
+
/** Custom URL parameter name for page */
|
|
15
|
+
pageParam?: string;
|
|
16
|
+
/** Custom URL parameter name for per page */
|
|
17
|
+
perPageParam?: string;
|
|
6
18
|
}
|
|
7
19
|
export interface DataViewPaginationProps extends UseDataViewPaginationProps {
|
|
8
20
|
/** Current page number */
|
|
9
21
|
page: number;
|
|
10
22
|
}
|
|
11
|
-
export declare const useDataViewPagination: ({ page, perPage }: UseDataViewPaginationProps) => {
|
|
23
|
+
export declare const useDataViewPagination: ({ page, perPage, searchParams, setSearchParams, pageParam, perPageParam, }: UseDataViewPaginationProps) => {
|
|
12
24
|
onPerPageSelect: (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newPerPage: number) => void;
|
|
13
25
|
onSetPage: (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newPage: number) => void;
|
|
14
26
|
page: number;
|
|
@@ -1,10 +1,42 @@
|
|
|
1
|
-
import { useState } from "react";
|
|
2
|
-
export
|
|
3
|
-
|
|
1
|
+
import { useState, useEffect } from "react";
|
|
2
|
+
export var PaginationParams;
|
|
3
|
+
(function (PaginationParams) {
|
|
4
|
+
PaginationParams["PAGE"] = "page";
|
|
5
|
+
PaginationParams["PER_PAGE"] = "perPage";
|
|
6
|
+
})(PaginationParams || (PaginationParams = {}));
|
|
7
|
+
export const useDataViewPagination = ({ page = 1, perPage, searchParams, setSearchParams, pageParam = PaginationParams.PAGE, perPageParam = PaginationParams.PER_PAGE, }) => {
|
|
8
|
+
const [state, setState] = useState({
|
|
9
|
+
page: parseInt((searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(pageParam)) || `${page}`),
|
|
10
|
+
perPage: parseInt((searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(perPageParam)) || `${perPage}`),
|
|
11
|
+
});
|
|
12
|
+
const updateSearchParams = (page, perPage) => {
|
|
13
|
+
if (searchParams && setSearchParams) {
|
|
14
|
+
const params = new URLSearchParams(searchParams);
|
|
15
|
+
params.set(pageParam, `${page}`);
|
|
16
|
+
params.set(perPageParam, `${perPage}`);
|
|
17
|
+
setSearchParams(params);
|
|
18
|
+
}
|
|
19
|
+
};
|
|
20
|
+
useEffect(() => {
|
|
21
|
+
// Make sure search params are loaded or set if not present on mount
|
|
22
|
+
updateSearchParams(state.page, state.perPage);
|
|
23
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
24
|
+
}, []);
|
|
25
|
+
useEffect(() => {
|
|
26
|
+
// Listen on URL params changes
|
|
27
|
+
const currentPage = parseInt((searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(pageParam)) || `${state.page}`);
|
|
28
|
+
const currentPerPage = parseInt((searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(perPageParam)) || `${state.perPage}`);
|
|
29
|
+
if (currentPage !== state.page || currentPerPage !== state.perPage) {
|
|
30
|
+
setState({ page: currentPage, perPage: currentPerPage });
|
|
31
|
+
}
|
|
32
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
33
|
+
}, [searchParams === null || searchParams === void 0 ? void 0 : searchParams.toString()]);
|
|
4
34
|
const onPerPageSelect = (_event, newPerPage) => {
|
|
5
|
-
|
|
35
|
+
updateSearchParams(1, newPerPage);
|
|
36
|
+
setState({ perPage: newPerPage, page: 1 });
|
|
6
37
|
};
|
|
7
38
|
const onSetPage = (_event, newPage) => {
|
|
39
|
+
updateSearchParams(newPage, state.perPage);
|
|
8
40
|
setState(prev => (Object.assign(Object.assign({}, prev), { page: newPage })));
|
|
9
41
|
};
|
|
10
42
|
return Object.assign(Object.assign({}, state), { onPerPageSelect,
|
|
@@ -40,8 +40,60 @@ describe('useDataViewPagination', () => {
|
|
|
40
40
|
expect(result.current).toEqual({
|
|
41
41
|
onPerPageSelect: expect.any(Function),
|
|
42
42
|
onSetPage: expect.any(Function),
|
|
43
|
-
page:
|
|
43
|
+
page: 1,
|
|
44
44
|
perPage: 50
|
|
45
45
|
});
|
|
46
46
|
});
|
|
47
|
+
it('should read pagination state from URL', () => {
|
|
48
|
+
const mockSearchParams = new URLSearchParams('page=2&perPage=10');
|
|
49
|
+
const { result } = renderHook(() => useDataViewPagination({
|
|
50
|
+
searchParams: mockSearchParams,
|
|
51
|
+
setSearchParams: jest.fn(),
|
|
52
|
+
page: 1,
|
|
53
|
+
perPage: 5,
|
|
54
|
+
}));
|
|
55
|
+
expect(result.current).toEqual({
|
|
56
|
+
onPerPageSelect: expect.any(Function),
|
|
57
|
+
onSetPage: expect.any(Function),
|
|
58
|
+
page: 2,
|
|
59
|
+
perPage: 10,
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
it('should set pagination state in URL when page changes', () => {
|
|
63
|
+
const mockSetSearchParams = jest.fn();
|
|
64
|
+
const { result } = renderHook(() => useDataViewPagination({
|
|
65
|
+
searchParams: new URLSearchParams(),
|
|
66
|
+
setSearchParams: mockSetSearchParams,
|
|
67
|
+
page: 1,
|
|
68
|
+
perPage: 5,
|
|
69
|
+
}));
|
|
70
|
+
expect(mockSetSearchParams).toHaveBeenNthCalledWith(1, new URLSearchParams('page=1&perPage=5'));
|
|
71
|
+
act(() => {
|
|
72
|
+
result.current.onSetPage(undefined, 4);
|
|
73
|
+
});
|
|
74
|
+
expect(mockSetSearchParams).toHaveBeenNthCalledWith(2, new URLSearchParams('page=4&perPage=5'));
|
|
75
|
+
});
|
|
76
|
+
it('should set pagination state in URL when perPage changes', () => {
|
|
77
|
+
const mockSetSearchParams = jest.fn();
|
|
78
|
+
const { result } = renderHook(() => useDataViewPagination({
|
|
79
|
+
searchParams: new URLSearchParams('page=2'),
|
|
80
|
+
setSearchParams: mockSetSearchParams,
|
|
81
|
+
page: 1,
|
|
82
|
+
perPage: 5,
|
|
83
|
+
}));
|
|
84
|
+
act(() => {
|
|
85
|
+
result.current.onPerPageSelect(undefined, 20);
|
|
86
|
+
});
|
|
87
|
+
expect(mockSetSearchParams).toHaveBeenCalledWith(new URLSearchParams('page=1&perPage=20'));
|
|
88
|
+
});
|
|
89
|
+
it('should initialize URL with default values if not present', () => {
|
|
90
|
+
const mockSetSearchParams = jest.fn();
|
|
91
|
+
renderHook(() => useDataViewPagination({
|
|
92
|
+
searchParams: new URLSearchParams(),
|
|
93
|
+
setSearchParams: mockSetSearchParams,
|
|
94
|
+
page: 1,
|
|
95
|
+
perPage: 5,
|
|
96
|
+
}));
|
|
97
|
+
expect(mockSetSearchParams).toHaveBeenCalledWith(new URLSearchParams('page=1&perPage=5'));
|
|
98
|
+
});
|
|
47
99
|
});
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export interface UseDataViewSelectionProps {
|
|
2
|
+
/** Function to compare items when checking if item is selected */
|
|
3
|
+
matchOption: (item: any, another: any) => boolean;
|
|
2
4
|
/** Array of initially selected entries */
|
|
3
5
|
initialSelected?: (any)[];
|
|
4
|
-
/** Function to compare items when checking if entry is selected */
|
|
5
|
-
matchOption?: (item: any, another: any) => boolean;
|
|
6
6
|
}
|
|
7
|
-
export declare const useDataViewSelection: (
|
|
7
|
+
export declare const useDataViewSelection: ({ matchOption, initialSelected }: UseDataViewSelectionProps) => {
|
|
8
8
|
selected: any[];
|
|
9
9
|
onSelect: (isSelecting: boolean, items?: any[] | any) => void;
|
|
10
10
|
isSelected: (item: any) => boolean;
|