30 lines
1.0 KiB
TypeScript
30 lines
1.0 KiB
TypeScript
|
import * as React from 'react';
|
||
|
|
/**
|
||
|
|
* Props for the WindowProvider component.
|
||
|
|
*/
|
||
|
|
export type WindowProviderProps = {
|
||
|
|
/**
|
||
|
|
* Provide the active window.
|
||
|
|
*/
|
||
|
|
window: Window | undefined;
|
||
|
|
children?: React.ReactNode;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* Context for providing the window.
|
||
|
|
*/
|
||
|
|
export declare const WindowContext: React.Context<WindowProviderProps>;
|
||
|
|
/**
|
||
|
|
* Hook to access the window object. This can be overridden contextually using the `WindowProvider`.
|
||
|
|
*/
|
||
|
|
export declare const useWindow: () => Window | undefined;
|
||
|
|
/**
|
||
|
|
* Hook to access the document object. This can be overridden contextually using the `WindowProvider`.
|
||
|
|
*/
|
||
|
|
export declare const useDocument: () => Document | undefined;
|
||
|
|
/**
|
||
|
|
* Component to provide the window object contextually. This is useful when rendering content to an element
|
||
|
|
* contained within a child window or iframe element, where event handlers and styling must be projected
|
||
|
|
* to an alternative window or document.
|
||
|
|
*/
|
||
|
|
export declare const WindowProvider: React.FunctionComponent<WindowProviderProps>;
|