0.2.4 • Published 2 years ago
@react-keycloak/keycloak-ts v0.2.4
KeycloakTS
Typescript porting of Keycloak javascript client
:construction: WIP: Under development :construction:
Table of Contents
Install
yarn add @react-keycloak/keycloak-ts
or
npm install @react-keycloak/keycloak-ts
Getting Started
KeycloakTS provides a porting of the original Keycloak javascript adapter to allow better extensibility and usage on different platform by using custom adapters.
Create a custom KeycloakAdapter
Create a class which implements the KeycloakAdapter
interface
import type { KeycloakAdapter } from '@react-keycloak/keycloak-ts';
// Wrap everything inside ReactNativeKeycloakProvider
class MyCustomAdapter implements KeycloakAdapter {
...
};
export default MyCustomAdapter;
Setup Keycloak instance
import { KeycloakClient } from '@react-keycloak/keycloak-ts';
import MyCustomAdapter from './adapter.ts';
// Setup Keycloak client as needed
// Pass initialization options as required
const keycloak = new KeycloakClient({
url: 'http://keycloak-server/auth',
realm: 'kc-realm',
clientId: 'web'
});
// Call init passing a custom adapter
keycloak.init({
adapter: MyCustomAdapter,
});
export default keycloak;
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
0.2.4
2 years ago
0.2.3
3 years ago
0.2.2
3 years ago
0.2.1
3 years ago
0.1.0
4 years ago
0.2.0
4 years ago
0.1.0-beta.2
4 years ago
0.1.0-beta.1
4 years ago
0.1.0-beta.0
4 years ago