reactuals
Version:
A useful package providing a collection of 50+ React hooks and utilities to simplify React development.
25 lines (24 loc) • 763 B
TypeScript
/**
* Options for the usePictureInPicture hook.
*/
type UsePictureInPictureOptions = {
windowFeatures?: string;
onOpen?: (pipWindow: Window) => void;
onClose?: () => void;
injectStyles?: string;
injectScripts?: string;
};
/**
* React hook to open and manage a Document Picture-in-Picture window.
*
* @param options Configuration options for the PiP window.
* @returns Object with open/close functions, state, and error info.
*/
export declare function usePictureInPicture(options?: UsePictureInPictureOptions): {
openPictureInPicture: (content: HTMLElement, overrideStyles?: string) => Promise<void>;
closePictureInPicture: () => void;
isActive: boolean;
error: Error | null;
pipWindow: Window | null;
};
export {};