datocms-plugin-sdk/dist/types/hooks/renderInspectorPanel.d.ts

DatoCMS Plugin SDK

import { ImposedSizePluginFrameCtx } from '../ctx/pluginFrame';
export type RenderInspectorPanelHook = {
    /**
     * This function will be called when an inspector needs to render a specific
     * panel (see the `renderInspector` and `setInspectorMode` functions)
     *
     * @tag inspector
     */
    renderInspectorPanel: (panelId: string, ctx: RenderInspectorPanelCtx) => void;
};
export type RenderInspectorPanelCtx = ImposedSizePluginFrameCtx<'renderInspectorPanel', {
    /** The ID of the inspector panel that needs to be rendered */
    panelId: string;
    /**
     * The arbitrary `parameters` of the modal declared in the `setInspectorMode`
     * function
     */
    parameters: Record<string, unknown>;
}>;
export declare const renderInspectorPanelBootstrapper: import("../utils").Bootstrapper<"renderInspectorPanel">;