UNPKG

@dataunlocker/defender-react

Version:

DataUnlocker Defender for React applications.

34 lines (33 loc) 1.19 kB
import { FC, HTMLAttributes, ReactNode } from 'react'; import { DefenderOnErrorHandler, DefenderOnLoadHandler } from './utils.js'; interface Props extends Omit<HTMLAttributes<HTMLDivElement>, 'onLoad' | 'onError'> { /** Children tree of your application as if no Defender is installed. */ children?: ReactNode; /** * DataUnlocker Defender load handler which is executed when it's fully ready. * * Note: onError can still happen after the load and should stop the app. */ onLoad?: DefenderOnLoadHandler; /** * DataUnlocker Defender error handler which is executed either before and after onLoad. * * Handling onError by preventing your application's interactivity is crucial for DataUnlocker to stay effective even after your site is discovered by blockers. */ onError?: DefenderOnErrorHandler; } /** * Handles DataUnlocker Defender load and error states under the hood. * * Usage example: * * ```js * import { Defender } from '@dataunlocker/defender-react'; * * const Layout = ({ children }) => { * return <Defender>{ children }</Defender> * } * ``` */ declare const Defender: FC<Props>; export default Defender;