import type { SchemaTypes } from '@datocms/cma-client'; import { Ctx } from '../ctx/base'; type ItemType = SchemaTypes.ItemType; export type ItemFormSidebarsHook = { /** * Use this function to declare new sidebar to be shown when the user edits * records of a particular model * * @tag sidebarPanels */ itemFormSidebars: (itemType: ItemType, ctx: ItemFormSidebarsCtx) => ItemFormSidebar[]; }; export type ItemFormSidebarsCtx = Ctx; /** * An object expressing a sidebar to be shown when the user edits * records of a particular model * * @see {isItemFormSidebar} */ export type ItemFormSidebar = { /** * ID of the sidebar. Will be the first argument for the * `renderItemFormSidebar` function */ id: string; /** Label to be shown on the collapsible sidebar handle */ label: string; /** * An arbitrary configuration object that will be passed as the `parameters` * property of the second argument of the `renderItemFormSidebar` function */ parameters?: Record; /** * If multiple sidebars specify the same `placement`, they will be sorted by * ascending `rank`. If you want to specify an explicit value for `rank`, make * sure to offer a way for final users to customize it inside the plugin's * settings form, otherwise the hardcoded value you choose might clash with * the one of another plugin! */ rank?: number; /** The preferred width for the sidebar */ preferredWidth?: number; }; export declare function isItemFormSidebar(value: unknown): value is ItemFormSidebar; export declare function isReturnTypeOfItemFormSidebarsHook(value: unknown): value is ItemFormSidebar[]; export {};