@iframe-resizer/core 6.0.0-beta.2 → 6.0.0-beta.4

package/index.d.ts

@@ -1,3 +1,165 @@
-export { LOG_COLLAPSED, LOG_DISABLED, LOG_EXPANDED } from '../common/consts';
-export type { Direction, IFrameComponent, IFrameMessageData, IFrameMouseData, IFrameObject, IFrameOptions, IFrameResizedData, IFrameScrollData, LogOption, MessageData, ScrollOption, } from './types';
-export default function connectResizer(options: Record<string, any>): (iframe: HTMLIFrameElement) => any;
+declare const AUTO = "auto";
+
+declare const BOTH = "both";
+
+declare const COLLAPSE = "collapsed";
+
+declare function connectResizer(options: Record<string, any>): (iframe: HTMLIFrameElement) => any;
+export default connectResizer;
+
+export declare type Direction = typeof VERTICAL | typeof HORIZONTAL | typeof NONE | typeof BOTH;
+
+declare const EXPAND = "expanded";
+
+declare const HORIZONTAL = "horizontal";
+
+/** HTMLIFrameElement with the `iframeResizer` control object attached. */
+export declare interface IframeComponent extends HTMLIFrameElement {
+    iframeResizer: IframeObject;
+}
+
+export declare interface IframeMessageData {
+    iframe: IframeComponent;
+    message: any;
+}
+
+export declare interface IframeMouseData {
+    iframe: IframeComponent;
+    screenX: number;
+    screenY: number;
+    type: string;
+}
+
+export declare interface IframeObject {
+    /** Remove the iframe from the page. */
+    close(): void;
+    /** Disconnect iframe-resizer from the iframe. */
+    disconnect(): void;
+    /** Move the page in the iframe to the specified anchor. */
+    moveToAnchor(anchor: string): void;
+    /** Send a message to the iframe. */
+    sendMessage(message: any, targetOrigin?: string): void;
+}
+
+export declare interface IframeOptions {
+    /** Override the body background style in the iframe. */
+    bodyBackground?: string | null;
+    /**
+     * Override the default body margin style in the iframe.
+     * A string can be any valid value for the CSS margin attribute, for example '8px 3em'.
+     * A number value is converted into px.
+     */
+    bodyMargin?: number | string | null;
+    /**
+     * Override the default body padding style in the iframe.
+     * A string can be any valid value for the CSS padding attribute, for example '8px 3em'.
+     * A number value is converted into px.
+     */
+    bodyPadding?: number | string | null;
+    /**
+     * When set to true, only allow incoming messages from the domain listed in the
+     * src property of the iframe tag. If your iframe navigates between different
+     * domains, ports or protocols; then you will need to provide an array of URLs
+     * or disable this option.
+     */
+    checkOrigin?: boolean | string[];
+    /** Set the resizing direction of the iframe. */
+    direction?: Direction;
+    /** Custom iframe id. */
+    id?: string;
+    /**
+     * When enabled, in-page linking inside the iframe and from the iframe to the
+     * parent page will be enabled.
+     */
+    inPageLinks?: boolean;
+    /** Set iframe-resizer license key. */
+    license: string;
+    /** Enable/disable console logging. */
+    log?: LogOption;
+    /** Set offset size of iframe content. */
+    offsetSize?: number;
+    /** Enable scroll bars in the iframe. */
+    scrolling?: ScrollOption;
+    /**
+     * Set the number of pixels the iframe content size has to change by,
+     * before triggering a resize of the iframe.
+     */
+    tolerance?: number;
+    /** Wait for the iframe to load before initializing. */
+    waitForLoad?: boolean;
+    /** Timeout in ms before warning if iframe has not responded. */
+    warningTimeout?: number;
+    /**
+     * Called before iframe is closed via parentIframe.close() or
+     * iframe.iframeResizer.close() methods. Returning false will prevent
+     * the iframe from closing.
+     */
+    onBeforeClose?(iframeId: string): boolean | void;
+    /** Called after iframe is closed. */
+    onAfterClose?(iframeId: string): void;
+    /** Called when pointer enters the iframe. */
+    onMouseEnter?(data: IframeMouseData): void;
+    /** Called when pointer leaves the iframe. */
+    onMouseLeave?(data: IframeMouseData): void;
+    /** Called when iframe-resizer has been initialized. */
+    onReady?(iframe: IframeComponent): void;
+    /**
+     * Receive message posted from the iframe with the
+     * parentIframe.sendMessage() method.
+     */
+    onMessage?(data: IframeMessageData): void;
+    /**
+     * Called after iframe resized. Passes event data containing the iframe,
+     * height, width and the type of event that triggered the resize.
+     */
+    onResized?(data: IframeResizedData): void;
+    /**
+     * Called before the page is repositioned after a request from the iframe.
+     * If this function returns false, it will stop the library from
+     * repositioning the page, so that you can implement your own scrolling.
+     */
+    onScroll?(data: IframeScrollData): boolean;
+}
+
+export declare interface IframeResizedData {
+    iframe: IframeComponent;
+    height: number;
+    width: number;
+    type: string;
+}
+
+export declare interface IframeScrollData {
+    iframe: IframeComponent;
+    top: number;
+    left: number;
+}
+
+export declare const LOG_COLLAPSED = 1;
+
+export declare const LOG_DISABLED = 0;
+
+export declare const LOG_EXPANDED = 2;
+
+export declare type LogOption = boolean | typeof EXPAND | typeof COLLAPSE | number;
+
+export declare interface MessageData {
+    id: string;
+    iframe: HTMLIFrameElement;
+    height: number;
+    width: number;
+    type: string;
+    msg?: string;
+    message?: string;
+    mode?: string;
+    [key: string]: any;
+}
+
+declare const NONE = "none";
+
+declare const OMIT = "omit";
+
+export declare type ScrollOption = boolean | typeof AUTO | typeof OMIT;
+
+declare const VERTICAL = "vertical";
+
+export { }