@keycloakify/keycloak-account-ui 25.0.1-rc.0 → 25.0.1-rc.2
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 +44 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,23 +1,53 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://github.com/user-attachments/assets/e31c4910-7205-441c-9a35-e134b806b3a8">
|
|
3
|
+
</p>
|
|
4
|
+
<p align="center">
|
|
5
|
+
<i>Repackaged Keycloak Account UI</i>
|
|
6
|
+
<br>
|
|
7
|
+
<br>
|
|
8
|
+
<a href="https://github.com/keycloakify/keycloak-account-ui/actions">
|
|
9
|
+
<img src="https://github.com/keycloakify/keycloak-account-ui/actions/workflows/ci.yaml/badge.svg?branch=main">
|
|
10
|
+
</a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@keycloakify/keycloak-account-ui/v/25.0.1-rc.2">
|
|
12
|
+
<img src="https://img.shields.io/npm/dm/@keycloakify/keycloak-account-ui">
|
|
13
|
+
</a>
|
|
14
|
+
<p align="center">
|
|
15
|
+
Check out our discord server!<br/>
|
|
16
|
+
<a href="https://discord.gg/mJdYJSdcm4">
|
|
17
|
+
<img src="https://dcbadge.limes.pink/api/server/kYFZG7fQmn"/>
|
|
18
|
+
</a>
|
|
19
|
+
</p>
|
|
20
|
+
</p>
|
|
21
|
+
|
|
22
|
+
This project re-packages [`@keycloak/keycloak-account-ui`](https://www.npmjs.com/package/@keycloak/keycloak-account-ui).
|
|
23
|
+
All credits goes to the keycloak team for the original work. Mainly [@jonkoops
|
|
24
|
+
](https://github.com/jonkoops) and [@edewit](https://github.com/edewit).
|
|
25
|
+
|
|
26
|
+
This re-packaged distribution exists to make it possible to take ownership of
|
|
27
|
+
some specific part of the Account UI to create your own custom version of it.
|
|
28
|
+
In straight forward therms it make the Account UI ejectable, you can copy
|
|
29
|
+
past [the source files](https://unpkg.com/browse/@keycloakify/keycloak-account-ui@25.0.1-rc.2/src/) that you want to modify into your codebase.
|
|
2
30
|
|
|
3
|
-
This project is a re-packaged version of the [`@keycloak/keycloak-account-ui`](https://www.npmjs.com/package/@keycloak/keycloak-account-ui) package.
|
|
4
|
-
The version of [`@keycloakify/keycloak-account-ui`](https://www.npmjs.com/package/@keycloakify/keycloak-account-ui) matches that of the original package.
|
|
5
|
-
The purpose of this package is to allow cherry-picking imports and taking ownership of specific portions of the package.
|
|
6
31
|
For more details on integrating this package into your project, refer to the [Keycloakify documentation](https://keycloakify.dev).
|
|
7
32
|
|
|
8
|
-
> **Note:** This package's GitHub repository does not contain any code as it is automatically generated at build time by [scripts/prepare.ts](/scripts/prepare.ts).
|
|
33
|
+
> **Note:** This package's GitHub repository does not contain any code as it is automatically generated at build time by [scripts/prepare.ts](/scripts/prepare.ts).
|
|
34
|
+
> You can browse the sources includes int the NPM package [here](https://unpkg.com/browse/@keycloakify/keycloak-account-ui@25.0.1-rc.2/src/).
|
|
9
35
|
|
|
10
36
|
## Installation
|
|
11
37
|
|
|
12
|
-
> You are currently viewing the
|
|
13
|
-
>
|
|
38
|
+
> You are currently viewing the README of [`@keycloakify/keycloak-account-ui@25.0.1-rc.2`](https://www.npmjs.com/package/@keycloakify/keycloak-account-ui/v/25.0.1-rc.2) that
|
|
39
|
+
> mirrors [`@keycloak/keycloak-account-ui@25.0.1`](https://www.npmjs.com/package/@keycloak/keycloak-account-ui/v/25.0.1).
|
|
40
|
+
> It is the version of the Account UI that ships with [**Keycloak 25.0.1**](https://github.com/keycloak/keycloak/tree/25.0.1/js/apps/account-ui).
|
|
41
|
+
|
|
42
|
+
Here are all the dependencies that are required to use the Account UI in your project.
|
|
43
|
+
It's important to respect the exact version range listed here to avoid any compatibility issues.
|
|
14
44
|
|
|
15
|
-
|
|
45
|
+
`package.json`
|
|
16
46
|
|
|
17
47
|
```json
|
|
18
48
|
{
|
|
19
49
|
"dependencies": {
|
|
20
|
-
"@keycloakify/keycloak-account-ui": "25.0.1-rc.
|
|
50
|
+
"@keycloakify/keycloak-account-ui": "25.0.1-rc.2",
|
|
21
51
|
"@patternfly/patternfly": "^5.3.1",
|
|
22
52
|
"@patternfly/react-core": "^5.3.3",
|
|
23
53
|
"@patternfly/react-icons": "^5.3.2",
|
|
@@ -37,3 +67,8 @@ To install this package, you must also install all the required peer dependencie
|
|
|
37
67
|
}
|
|
38
68
|
}
|
|
39
69
|
```
|
|
70
|
+
|
|
71
|
+
## Ejecting
|
|
72
|
+
|
|
73
|
+
You can take partial ownership of some parts of the Account UI by copy pasting the sources files you want to modify into your codebase.
|
|
74
|
+
You can browse the sources files **[here](https://unpkg.com/browse/@keycloakify/keycloak-account-ui@25.0.1-rc.2/src/)**.
|