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

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

import type { Options } from "../types/options";
export type ShowWorkflowBuilderProps = Options & {
    workflowId: string;
};
/**
 * Renders the workflow builder for a specific workflow, allowing your customer's
 * users to view and modify the workflow's steps, triggers, and configuration.
 *
 * @param props - Display options including the workflow to open.
 * @param props.workflowId - The ID of the workflow to open in the builder.
 *
 * @example
 * // Open a specific workflow in a popover
 * prismatic.showWorkflow({
 *   workflowId: "V29ya2Zsb3c6YTFiMmMz...",
 *   usePopover: true,
 * });
 *
 * @example
 * // Open a specific workflow inline
 * prismatic.showWorkflow({
 *   workflowId: "V29ya2Zsb3c6YTFiMmMz...",
 *   selector: "#workflow-container",
 * });
 *
 * @see {@link https://prismatic.io/docs/embed/workflow-builder/workflow-builder/ | Embedding the Workflow Builder}
 */
export declare const showWorkflow: ({ workflowId, ...options }: ShowWorkflowBuilderProps) => void;