@apicurio/common-ui-components 2.1.0 → 3.0.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 +36 -1
- package/dist/auth/AuthConfigContext.d.ts +22 -0
- package/dist/main.js +3800 -1498
- package/dist/style.css +1 -0
- package/package.json +19 -19
package/README.md
CHANGED
|
@@ -2,6 +2,18 @@
|
|
|
2
2
|
This library contains some React + Patternfly UI components that are used across multiple Apicurio
|
|
3
3
|
UI projects.
|
|
4
4
|
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
This library requires the following peer dependencies:
|
|
8
|
+
|
|
9
|
+
- React 18.x
|
|
10
|
+
- PatternFly 6.x
|
|
11
|
+
- @patternfly/patternfly ~6
|
|
12
|
+
- @patternfly/react-core ~6
|
|
13
|
+
- @patternfly/react-icons ~6
|
|
14
|
+
- @patternfly/react-table ~6
|
|
15
|
+
- Additional peer dependencies listed in package.json
|
|
16
|
+
|
|
5
17
|
## Building
|
|
6
18
|
Use standard Node/NPM tooling to build the code in this library.
|
|
7
19
|
|
|
@@ -21,4 +33,27 @@ npm run dev
|
|
|
21
33
|
```
|
|
22
34
|
|
|
23
35
|
Once running, open your browser to the URL indicated by the output of `npm run dev`. You will
|
|
24
|
-
see the showcase application.
|
|
36
|
+
see the showcase application.
|
|
37
|
+
|
|
38
|
+
## Migrating to v3.0.0 (PatternFly v6)
|
|
39
|
+
|
|
40
|
+
### Prerequisites
|
|
41
|
+
Your application must be using PatternFly v6. If you are still on PatternFly v5, follow the
|
|
42
|
+
[official PatternFly upgrade guide](https://www.patternfly.org/get-started/upgrade/) first.
|
|
43
|
+
|
|
44
|
+
### Steps
|
|
45
|
+
1. Update your application to PatternFly v6
|
|
46
|
+
2. Update this library to v3.0.0:
|
|
47
|
+
```bash
|
|
48
|
+
npm install @apicurio/common-ui-components@3.0.0
|
|
49
|
+
```
|
|
50
|
+
3. No code changes required in your application - all component APIs remain compatible
|
|
51
|
+
|
|
52
|
+
### What Changed
|
|
53
|
+
- Visual styling now matches PatternFly v6 design system
|
|
54
|
+
- Filter chips now use Label component (visually similar, no API changes)
|
|
55
|
+
- Modal components temporarily use deprecated PatternFly imports (will be updated in future)
|
|
56
|
+
|
|
57
|
+
### Known Issues
|
|
58
|
+
- Modal components use the deprecated Modal from PatternFly v6. This will be addressed in a future
|
|
59
|
+
release.
|
|
@@ -26,6 +26,28 @@ export interface OidcAuthOptions {
|
|
|
26
26
|
* @default 300000 (5 minutes)
|
|
27
27
|
*/
|
|
28
28
|
stateMaxAge?: number;
|
|
29
|
+
/**
|
|
30
|
+
* Custom redirect handler for client-side navigation after OIDC authentication.
|
|
31
|
+
* This allows React Router or other routing libraries to handle navigation
|
|
32
|
+
* without causing a full page refresh.
|
|
33
|
+
*
|
|
34
|
+
* If not provided, defaults to `window.location.href = location` which causes
|
|
35
|
+
* a full page reload.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* // With React Router v6
|
|
39
|
+
* import { useNavigate } from 'react-router-dom';
|
|
40
|
+
*
|
|
41
|
+
* const navigate = useNavigate();
|
|
42
|
+
* const authConfig = {
|
|
43
|
+
* type: "oidc",
|
|
44
|
+
* options: {
|
|
45
|
+
* // ... other options
|
|
46
|
+
* onRedirect: (location) => navigate(location)
|
|
47
|
+
* }
|
|
48
|
+
* };
|
|
49
|
+
*/
|
|
50
|
+
onRedirect?: (location: string) => void;
|
|
29
51
|
}
|
|
30
52
|
export interface AuthConfig {
|
|
31
53
|
type: "none" | "basic" | "oidc";
|