browser-sdk

Home > @datadog/browser-rum-react > reactPlugin

reactPlugin() function

Factory returning the react plugin to pass to datadogRum.init({ plugins: […] }).

The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM *Error* events) - Optional react-router view tracking - Component performance tracking utilities (see UNSTABLE_ReactComponentTracker).

Signature:

export declare function reactPlugin(configuration?: ReactPluginConfiguration): {
 name: string;
 onInit({ publicApi, initConfiguration }: {
 initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration;
 publicApi: RumPublicApi;
 }): void;
 onRumStart({ strategy }: {
 strategy: Strategy;
 }): void;
 getConfigurationTelemetry(): {
 router: boolean;
 };
};

Parameters

Parameter	Type	Description
configuration	ReactPluginConfiguration	(Optional) React plugin specific configuration.

Returns:

{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import(“@datadog/browser-rum-core”).RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; }

A RUM plugin instance to include in the SDK init.

This site is open source. Improve this page.