datocms-plugin-sdk
Version:
22 lines (21 loc) • 967 B
TypeScript
import { ItemFormAdditionalMethods, ItemFormAdditionalProperties } from '../ctx/commonExtras/itemForm';
import { ImposedSizePluginFrameCtx } from '../ctx/pluginFrame';
export type RenderItemFormSidebarHook = {
/**
* This function will be called when the plugin needs to render a sidebar (see
* the `itemFormSidebars` hook)
*
* @tag sidebarPanels
*/
renderItemFormSidebar: (sidebarId: string, ctx: RenderItemFormSidebarCtx) => void;
};
export type RenderItemFormSidebarCtx = ImposedSizePluginFrameCtx<'renderItemFormSidebar', ItemFormAdditionalProperties & {
/** The ID of the sidebar that needs to be rendered */
sidebarId: string;
/**
* The arbitrary `parameters` of the declared in the `itemFormSidebars`
* function
*/
parameters: Record<string, unknown>;
}, ItemFormAdditionalMethods>;
export declare const renderItemFormSidebarBootstrapper: import("../utils").Bootstrapper<"renderItemFormSidebar">;