Skip to main content

react

Enumerations

Interfaces

Type Aliases

KeycloakConnectorStateActions

Ƭ KeycloakConnectorStateActions: { payload: KeycloakConnectorClient ; type: SET_KCC_CLIENT } | { payload: Event | CustomEvent<UserStatus> ; type: KCC_CLIENT_EVENT } | { type: DESTROY_CLIENT | LENGTHY_LOGIN | SHOW_LOGIN | SHOW_LOGOUT | EXECUTING_LOGOUT | HIDE_DIALOG }

Defined in

types.ts:35


ReactConfig

Ƭ ReactConfig: Object

Type declaration

NameTypeDescription
deferredStart?booleanDefer the start of the plugin
disableAuthComponents?boolean-
globalEventListener?EventListenerFunction<ClientEvent>Can specify an event listener to catch all emitted events
loginModalChildren?ReactNodeDesc Specify a component to pass to the login modal for slight customization
logoutModalChildren?ReactNodeDesc Specify a component to pass to the logout modal for slight customization

Defined in

components/KeycloakConnectorProvider.tsx:18

Functions

KeycloakConnectorProvider

KeycloakConnectorProvider(«destructured»): Element

Parameters

NameType
«destructured»ConnectorProviderProps

Returns

Element

Defined in

components/KeycloakConnectorProvider.tsx:65


Login

Login(«destructured»): Element

Parameters

NameType
«destructured»AuthProps

Returns

Element

Defined in

components/Login.tsx:5


useKeycloakConnector

useKeycloakConnector(): [KeycloakConnectorContextProps, Dispatch<KeycloakConnectorStateActions>]

Returns

[KeycloakConnectorContextProps, Dispatch<KeycloakConnectorStateActions>]

Defined in

use-keycloak-connector.ts:7