@joint/react/dist/types/hooks/use-create-paper.d.ts

React bindings and hooks for JointJS to build interactive diagrams and graphs.

import type { PaperEvents } from '../types/event.types';
import { PaperContext } from '../context';
interface UseCreatePaperOptions extends PaperEvents {
    /**
     * On load custom element.
     * If provided, it must return valid HTML or SVG element and it will be replaced with the default paper element.
     * So it overwrite default paper rendering.
     * It is used internally for example to render `PaperScroller` from [joint plus](https://www.jointjs.com/jointjs-plus) package.
     * @param paperCtx - The paper context
     * @returns
     */
    readonly overwriteDefaultPaperElement?: (paperCtx: PaperContext) => HTMLElement | SVGElement;
    readonly scale?: number;
}
/**
 * Custom hook to use a JointJS paper instance.
 * It retrieves the paper from the PaperContext or creates a new instance.
 * Returns a reference to the paper HTML element.
 * This hook must be already be defined inside `PaperProvider`
 * @group Hooks
 * @internal
 * @param options - Options for creating the paper instance.
 * @returns An object containing the paper instance and a reference to the paper HTML element.
 */
export declare function useCreatePaper(options?: UseCreatePaperOptions): {
    paperCtx: PaperContext | null;
    paperContainerElement: import("react").RefObject<HTMLDivElement | null>;
};
export {};