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
AppProviders({ ctx, packageName, resolveMessages: resolveMessagesFn, defaultMessages, defaultLanguage, children })	(ALPHA) Standard provider stack for pluggable application modules.
createBackendForModule(auth, options)	(ALPHA) Creates an analytical backend instance from the platform context auth credentials.
PlatformContextProvider({ value, children })	(ALPHA) React provider that binds platform context into React context.
PluggableAppEventsProvider({ onEvent, children })	(ALPHA) React provider exposing pluggable-to-host event helpers.
usePlatformContext()	(ALPHA) Returns client platform context snapshot (or undefined if not available yet).
usePlatformContextStrict(context)	(ALPHA) Returns client platform context snapshot and throws if it's not available.
usePluggableAppEvents()	(ALPHA) Returns event helpers for communication with host.

Interfaces

Interface	Description
IAppProvidersProps	(ALPHA) Props for AppProviders().
IClientPlatformContext	(ALPHA) Platform context extended with a client-created backend instance.
ICreateBackendForModuleOptions	(ALPHA) Options for createBackendForModule().
IPlatformContextProviderProps	(ALPHA) Props for PlatformContextProvider().
IPluggableAppEventsContextValue	(ALPHA) Value exposed by PluggableAppEventsProvider().
IPluggableAppEventsProviderProps	(ALPHA) Props for PluggableAppEventsProvider().