@prismatic-io/embedded
Version:
Embed Prismatic's integration marketplace and workflow designer within your existing application.
28 lines (27 loc) • 915 B
TypeScript
import type { Options } from "../types/options";
export type ShowWorkflowsProps = Options & {};
/**
* Renders the workflows list screen, where your customer's users can browse
* and manage their workflows.
*
* Set `screenConfiguration.workflows.includeIntegrations` to also display
* integrations alongside workflows.
*
* @param options - Display options for the workflows list.
*
* @example
* // Show workflows list in a popover
* prismatic.showWorkflows({ usePopover: true });
*
* @example
* // Show workflows inline, including integrations
* prismatic.showWorkflows({
* selector: "#workflows-container",
* screenConfiguration: {
* workflows: { includeIntegrations: true },
* },
* });
*
* @see {@link https://prismatic.io/docs/embed/workflow-builder/workflow-builder/ | Embedding the Workflow Builder}
*/
export declare const showWorkflows: (options: ShowWorkflowsProps) => void;