Skip to content

hooks/usePluginContext#

PluginProvider()#

function PluginProvider(props): Element;

Plugin context provider

Parameters#

Parameter Type
props PluginProviderProps

Returns#

Element

usePluginContext()#

function usePluginContext(): PluginContext;

Hook to access plugin context

Returns#

PluginContext

PluginContextValue#

const PluginContextValue: Context;

PluginContext#

Plugin context - provides API for plugins to communicate with backend

Properties#

logger#

logger: {
  debug: (message) => void;
  error: (message) => void;
  info: (message) => void;
  warn: (message) => void;
};

Logger

debug#
debug: (message) => void;
Parameters#
Parameter Type
message string
Returns#

void

error#
error: (message) => void;
Parameters#
Parameter Type
message string
Returns#

void

info#
info: (message) => void;
Parameters#
Parameter Type
message string
Returns#

void

warn#
warn: (message) => void;
Parameters#
Parameter Type
message string
Returns#

void

onMessage#

onMessage: (topic, handler) => () => void;

Subscribe to messages from backend

Parameters#
Parameter Type
topic string
handler (payload) => void
Returns#

() => void

pluginId#

pluginId: string;

Plugin ID

sendMessage#

sendMessage: <T>(topic, payload) => Promise<T>;

Send message to backend plugin and await response

Type Parameters#
Type Parameter Default type
T unknown
Parameters#
Parameter Type
topic string
payload unknown
Returns#

Promise<T>