datocms-plugin-sdk
Version:
26 lines (25 loc) • 1 kB
TypeScript
import { SchemaTypes } from '@datocms/cma-client';
import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
type Upload = SchemaTypes.Upload;
export type RenderUploadSidebarPanelHook = {
/**
* This function will be called when the plugin needs to render a sidebar panel
* (see the `uploadSidebarPanels` hook)
*
* @tag sidebarPanels
*/
renderUploadSidebarPanel: (sidebarPaneId: string, ctx: RenderUploadSidebarPanelCtx) => void;
};
export type RenderUploadSidebarPanelCtx = SelfResizingPluginFrameCtx<'renderUploadSidebarPanel', {
/** The ID of the sidebar panel that needs to be rendered */
sidebarPaneId: string;
/**
* The arbitrary `parameters` of the panel declared in the
* `uploadSidebarPanels` function
*/
parameters: Record<string, unknown>;
/** The active asset */
upload: Upload;
}>;
export declare const renderUploadSidebarPanelBootstrapper: import("../utils").Bootstrapper<"renderUploadSidebarPanel">;
export {};