@prismatic-io/embedded/dist/lib/showDesigner.d.ts

Embed Prismatic's integration marketplace and workflow designer within your existing application.

import type { Options } from "../types/options";
export type ShowDesignerProps = Options & {
    integrationId: string;
};
/**
 * Renders the embedded integration designer for a specific integration, allowing
 * your customer's users to build and modify integration workflows.
 *
 * Requires the embedded designer feature to be enabled for the customer.
 *
 * @param props - Display options including the integration to open.
 * @param props.integrationId - The ID of the integration to open in the designer.
 *
 * @example
 * // Open the designer for a specific integration in a popover
 * prismatic.showDesigner({
 *   integrationId: "SW50ZWdyYXRpb246YzNmOGU...",
 *   usePopover: true,
 * });
 *
 * @example
 * // Open the designer inline
 * prismatic.showDesigner({
 *   integrationId: "SW50ZWdyYXRpb246YzNmOGU...",
 *   selector: "#designer-container",
 * });
 *
 * @see {@link https://prismatic.io/docs/embed/workflow-builder/workflow-builder/ | Embedding the Workflow Builder}
 */
export declare const showDesigner: ({ integrationId, ...options }: ShowDesignerProps) => void;