@prismatic-io/embedded
Version:
Embed Prismatic's integration marketplace and workflow designer within your existing application.
25 lines (24 loc) • 860 B
TypeScript
import type { Options } from "../types/options";
export type ShowComponentsProps = Options & {};
/**
* Renders the component browser, where your customer's users can browse
* available components and their actions.
*
* Components can be filtered by category or label via the `filters` option.
*
* @param options - Display options for the components screen.
*
* @example
* // Show components in a popover
* prismatic.showComponents({ usePopover: true });
*
* @example
* // Show components inline, filtered by category
* prismatic.showComponents({
* selector: "#components-container",
* filters: { components: { category: "Data Platforms" } },
* });
*
* @see {@link https://prismatic.io/docs/embed/additional-screens/show-components/ | Embedding Components}
*/
export declare const showComponents: (options: ShowComponentsProps) => void;