Overview of sdk-ui-pluggable-application

Home > @gooddata/sdk-ui-pluggable-application

sdk-ui-pluggable-application package

React helpers for pluggable application integration.

Functions

Function	Description
createBackendForModule(auth, options)	(ALPHA) Creates an analytical backend instance from the platform context auth credentials.
PlatformContextProvider({ value, children })	React provider that binds platform context into React context.
usePlatformContext()	Returns client platform context snapshot (or undefined if not available yet).
usePlatformContextStrict(context)	Returns client platform context snapshot and throws if it's not available.

Interfaces

Interface	Description
IClientPlatformContext	Platform context extended with a client-created backend instance.
ICreateBackendForModuleOptions	(ALPHA) Options for createBackendForModule().
IPlatformContextProviderProps	Props for PlatformContextProvider().