bnb-passport-attestation
Version:
BAS SDK - A toolkit for blockchain interaction
37 lines (36 loc) • 1.36 kB
TypeScript
/**
* Options for creating and managing an iframe
* @interface UseIframeOptions
* @property {string} src - The URL of the iframe
* @property {number} [timeout] - The timeout for iframe loading in milliseconds, default is 10 seconds
* @property {boolean} [visible] - Whether the iframe is visible, default is false (hidden)
*/
interface UseIframeOptions {
/** The URL of the iframe */
src: string;
/** The timeout for iframe loading in milliseconds, default is 10 seconds */
timeout?: number;
/** Whether the iframe is visible, default is false (hidden) */
visible?: boolean;
}
/**
* Hook for creating and managing an iframe element
* Creates a hidden iframe with specified URL and handles its lifecycle
*
* @param {UseIframeOptions} options - Configuration options for the iframe
* @returns {Object} Object containing iframe reference and loading state
* @property {React.RefObject<HTMLIFrameElement>} iframeRef - Reference to the iframe element
* @property {boolean} loaded - Whether the iframe has finished loading
*
* @example
* const { iframeRef, loaded } = useCreate({
* src: 'https://example.com',
* timeout: 5000,
* visible: false
* });
*/
export declare function useCreate(options: UseIframeOptions): {
iframeRef: import("react").RefObject<HTMLIFrameElement | null>;
loaded: boolean;
};
export {};